about summary refs log tree commit diff
path: root/docs/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 000000000..000593761
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,24 @@
+Index
+=====
+
+**Mastodon** is a free, open-source GNU social-compatible social network server. A decentralized alternative to commercial platforms, it avoids the risks of a single company monopolizing your communication. Anyone can run Mastodon and participate in the social network seamlessly.
+
+### Using Mastodon
+- [Frequently Asked Questions](Using-Mastodon/FAQ.md)
+- [List of Mastodon instances](Using-Mastodon/List-of-Mastodon-instances.md)
+- [Apps](Using-Mastodon/Apps.md)
+
+### Using the API
+- [API documentation](Using-the-API/API.md)
+- [Testing the API with cURL](Using-the-API/Testing-with-cURL.md)
+- [OAuth details](Using-the-API/OAuth-details.md)
+- [Tips for app developers](Using-the-API/Tips-for-app-developers.md)
+
+### Running Mastodon
+- [Production guide](Running-Mastodon/Production-guide.md)
+- [Development guide](Running-Mastodon/Development-guide.md)
+
+### Contributing to Mastodon
+- [Sponsors](Contributing-to-Mastodon/Sponsors.md)
+- [Translate Mastodon in your language](Contributing-to-Mastodon/Translating.md)
+- [Report bugs and submit ideas](https://github.com/tootsuite/mastodon/issues)