tootlab-mastodon/docs/README.md

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)
- [User Guide](Using-Mastodon/User-guide.md)

### Using the API
- [API documentation](Using-the-API/API.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)

### Running Mastodon
- [Production guide](Running-Mastodon/Production-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)
- [Administration guide](Running-Mastodon/Administration-guide.md)
- [Tuning Mastodon](Running-Mastodon/Tuning.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)

### Protocols

- [List of used specs and RFCs for the federation](Specs-and-RFCs-used.md)
- [Extensions of the above protocols](Extensions.md)
Add wiki contents to docs/ instead 2017-01-21 16:49:08 -05:00			`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)`
Add user guide to README toc 2017-04-02 17:05:21 -04:00			`- [User Guide](Using-Mastodon/User-guide.md)`
Add wiki contents to docs/ instead 2017-01-21 16:49:08 -05:00
			`### Using the API`
			`- [API documentation](Using-the-API/API.md)`
Adding documentation for streaming API. Fixing filtering bug 2017-02-02 10:35:06 -05:00			`- [Streaming API documentation](Using-the-API/Streaming-API.md)`
Add wiki contents to docs/ instead 2017-01-21 16:49:08 -05:00			`- [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)`
Add more links to main docs page 2017-01-29 06:59:02 -05:00			`- [Push notifications](Using-the-API/Push-notifications.md)`
Add wiki contents to docs/ instead 2017-01-21 16:49:08 -05:00
			`### Running Mastodon`
			`- [Production guide](Running-Mastodon/Production-guide.md)`
Add more links to main docs page 2017-01-29 06:59:02 -05:00			`- [Alternative: Running on Heroku](Running-Mastodon/Heroku-guide.md)`
Add separate sections for Heroku and Vagrant deployments. Add guide for instance administration. Move 'Contribution guide' to 'Development guide'. 2017-01-22 03:50:40 -05:00			`- [Development guide](Running-Mastodon/Development-guide.md)`
Add more links to main docs page 2017-01-29 06:59:02 -05:00			`- [Alternative: Development with Vagrant](Running-Mastodon/Vagrant-guide.md)`
Update broken links, add new sponsor 2017-01-27 11:01:21 -05:00			`- [Administration guide](Running-Mastodon/Administration-guide.md)`
Add tuning documentation, add <content> tags back to most salmons, make status pagination headers generation more lax about next page existing 2017-02-24 21:34:37 -05:00			`- [Tuning Mastodon](Running-Mastodon/Tuning.md)`
Add wiki contents to docs/ instead 2017-01-21 16:49:08 -05:00
			`### 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)`
Add more links to main docs page 2017-01-29 06:59:02 -05:00
			`### Protocols`

			`- [List of used specs and RFCs for the federation](Specs-and-RFCs-used.md)`
			`- [Extensions of the above protocols](Extensions.md)`