From 3ae7f4be3b0e532e11786c9518d1c16bd1d4d32b Mon Sep 17 00:00:00 2001 From: Eugen Rochko Date: Tue, 25 Jul 2017 18:04:52 +0200 Subject: [PATCH] Improve readme (#348) --- README.md | 54 ++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 34 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 2d4fe27f..5c994620 100644 --- a/README.md +++ b/README.md @@ -4,42 +4,56 @@ **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. ## Documentation - ### [Using Mastodon](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) -- [User Guide](Using-Mastodon/User-guide.md) +- [List of Mastodon instances](https://joinmastodon.org) ([Alternative list](https://instances.social)) +- [List of apps for Mastodon](Using-Mastodon/Apps.md) (or just search for Mastodon in your app store of choice) +- [User guide](Using-Mastodon/User-guide.md) ### [Using the API](Using-the-API) + - [API documentation](Using-the-API/API.md) -- [Libraries](Using-the-API/Libraries.md) - [Streaming API documentation](Using-the-API/Streaming-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) - [Push notifications](Using-the-API/Push-notifications.md) +- [Libraries](Using-the-API/Libraries.md) ### [Running Mastodon](Running-Mastodon) +#### In production -**Please note**: It is highly recommended to run a [tagged release](https://github.com/tootsuite/mastodon/releases) of Mastodon and **not** run off the current `master` branch. +>**Please note**: It is highly recommended to run a [tagged release](https://github.com/tootsuite/mastodon/releases) of Mastodon and **not** run off the current `master` branch. -- [Resources needed](Running-Mastodon/Resources-needed.md) -- [Production guide](Running-Mastodon/Production-guide.md) -- [Docker guide](Running-Mastodon/Docker-Guide.md) -- [Alternative: Running on Heroku](Running-Mastodon/Heroku-guide.md) -- [Development guide](Running-Mastodon/Development-guide.md) -- [Alternative: Development with Vagrant](Running-Mastodon/Vagrant-guide.md) -- [Alternative: Development _and_ Production with Nanobox](Running-Mastodon/Nanobox-Guide.md) -- [Administration guide](Running-Mastodon/Administration-guide.md) -- [Maintenance Tasks](Running-Mastodon/Maintenance-Tasks.md) -- [Tuning Mastodon](Running-Mastodon/Tuning.md) -- [System Configuration Alternatives](Running-Mastodon/Alternatives.md) -- [List of Rake tasks](Running-Mastodon/List-of-Rake-tasks.md) +- Before you start: [Examples of resource usage from other live instances](Running-Mastodon/Resources-needed.md) +- If you want to use Docker: [Installation using Docker](Running-Mastodon/Docker-Guide.md) +- If you want to run it standalone: [Standalone installation](Running-Mastodon/Production-guide.md) +- There are other options: + - [Mastodon on Heroku](Running-Mastodon/Heroku-guide.md) + - [Mastodon on Scalingo](Running-Mastodon/Scalingo-guide.md) + - [Mastodon on Nanobox](Running-Mastodon/Nanobox-Guide.md) +- After installation: + - [Administrating a Mastodon instance](Running-Mastodon/Administration-guide.md) + - [Tuning Mastodon performance](Running-Mastodon/Tuning.md) + - [List of terminal commands](Running-Mastodon/List-of-Rake-tasks.md) + - [Customizing the look](Running-Mastodon/Customizing.md) +- Advanced: + - [Serving Mastodon from a subdomain](Running-Mastodon/Serving_a_different_domain.md) + - [Scaling up with PgBouncer](Running-Mastodon/PgBouncer-guide.md) + +The aforementioned guides presume using certain software, like Nginx. But using alternatives is possible: [Alternative system configurations](Running-Mastodon/Alternatives.md) + +#### In development + +- [Setting up a development environment](Running-Mastodon/Development-guide.md) +- There are other options: + - [Using Vagrant](Running-Mastodon/Vagrant-guide.md) + - [Using Nanobox](Running-Mastodon/Nanobox-Guide.md) ### [Contributing to Mastodon](Contributing-to-Mastodon) -- [Sponsors](Contributing-to-Mastodon/Sponsors.md) -- [Translate Mastodon in your language](Contributing-to-Mastodon/Translating.md) +- 🎉 [List of Sponsors](Contributing-to-Mastodon/Sponsors.md) - thank you to these people! 🎉 +- [Translate Mastodon to your language](Contributing-to-Mastodon/Translating.md) - [Report bugs and submit ideas](https://github.com/tootsuite/mastodon/issues) ### Protocols