diff --git a/README.md b/README.md index 17d4c2dc..eabcfcdf 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,24 @@ -# tanssi-docs -Documentation for the Tanssi project +# Documentation for Tanssi + +This repository contains documentation for [Tanssi](https://tanssi.network], an Appchain infrastructure protocol to simplify and enhance parachain deployments secured by Polkadot. + +We welcome you to join the Tanssi community and contribute to this repository and to the [project](https://github.com/moondance-labs/tanssi). + +## About This Site + +The content in this repository is displayed on the Tanssi documentation site, [docs.tanssi.network](https://docs.tanssi.network), and is generated using [mkdocs](https://www.mkdocs.org/). The theme used is [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/). + +## Contributing + +If you're interested in contributing to this repository, please feel free to clone the repo, make changes, and open a PR ✨. Please review the guidelines in the [`.CONTRIBUTING.md` file](https://github.com/moondance-labs/tanssi-docs/blob/main/CONTRIBUTING.md) before making any changes. + +You can also [open an issue](https://github.com/moondance-labs/tanssi-docs/issues/new). Thank you for taking your time to contribute to this repository 💜. + +## Tanssi Community + +- **Discord** - technical support and development-focused conversation is found on our [Discord channel](https://discord.gg/kuyPhew2KB) +- **Telegram** - general information and other non-technical topics can be discussed in our [Telegram group](https://t.me/tanssiofficial) +- **Twitter** - follow us on Twitter for regular updates: [@TanssiNetwork](https://twitter.com/TanssiNetwork) +- **YouTube** - for video-tutorials and related content, subscribe to our [YouTube channel](https://www.youtube.com/@TanssiNetwork?sub_confirmation=1) +- **Newsletter** - Sign up for [our newsletter](https://www.tanssi.network/newsletter) to learn more about Tanssi +