tye/README.md

# Project Tye

Tye is a developer tool that makes developing, testing, and deploying microservices and distributed applications easier. Project Tye includes a local orchestrator to make developing microservices easier and the ability to deploy microservices to Kubernetes with minimal configuration. 

Tye can:

- Simplify microservices development by making it easy to:
  - Run many services with one command
  - Use dependencies in containers
  - Discover addresses of other services using simple conventions
- Deploy .NET applications to Kubernetes by:
  - Automatically containerizing .NET applications
  - Generating Kubernetes manifests with minimal knowledge or configuration
  - Using the same conventions as development to keep it consistent

Want to learn more? Check out our [FAQ](docs/FAQ.md) or [documentation](docs/README.md).

## Current Status

Project Tye is an open source experiment at the moment. We are using this time to try radical ideas to improve microservices developer productivity and see what works. 

We plan to do releases with new features roughly every 4 weeks.

For the duration of the experiment, consider every part of the tye experience to be volatile. We will frequently make additions and changes to features that seem polished. We welcome feedback from anyone who's willing to be an early-adopter with tye; the team wants to know what's working well, and what's missing to build a whole-package .NET microservices developer productivity suite.

---

[![Build Status](https://dnceng.visualstudio.com/public/_apis/build/status/dotnet/tye/dotnet-tye-ci-public?branchName=main)](https://dnceng.visualstudio.com/public/_build/latest?definitionId=796&branchName=main)


## Getting Started

See the getting started instructions and tutorials [here](/docs/getting_started.md).


## How to Engage, Contribute, and Give Feedback

Some of the best ways to contribute are to try things out, file issues, join in design conversations, and make pull-requests.

- Download our latest daily builds
- Try tutorials and working with your own projects
- Log issues if you find problems, or if you have suggestions.
- Log an issue if you have feedback you want to share with the team.

Check out the [contributing](/CONTRIBUTING.md) page to see the best places to log issues and start discussions.

Thank you for trying out Project Tye! We highly encourage you to provide feedback to help us continue to improve the tool, so we would love to learn more about your experience. Please let us know what you think by filling out our [survey](https://aka.ms/tyesurvey).

## Reporting security issues and bugs

Tye is an experimental project, and as such we expect all users to take responsibility for evaluating the security of their own applications.

Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) secure@microsoft.com. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the MSRC PGP key, can be found in the Security TechCenter.

## .NET Foundation

Tye is a [.NET Foundation](https://www.dotnetfoundation.org/projects) project.

This project has adopted the code of conduct defined by the [Contributor Covenant](http://contributor-covenant.org/) to clarify expected behavior in our community. For more information, see the [.NET Foundation Code of Conduct](http://www.dotnetfoundation.org/code-of-conduct).

General .NET OSS discussions: [.NET Foundation forums](https://forums.dotnetfoundation.org)