Commit 343bee28 authored by Eugen Rochko's avatar Eugen Rochko

Improve README

parent 226dd4af
# README
# Mastodon Bridge
This README would normally document whatever steps are necessary to get the
application up and running.
This is a simple web app that helps you find your Twitter friends on the federated Mastodon network. It is also an example of how the Mastodon API can be used and the federated OAuth authorization flow.
Things you may want to cover:
## Links
* Ruby version
* System dependencies
* Configuration
* Database creation
* Database initialization
* How to run the test suite
* Services (job queues, cache servers, search engines, etc.)
* Deployment instructions
* ...
- [Ruby gem for Mastodon API](https://github.com/Gargron/mastodon-api)
- [OmniAuth strategy for Mastodon](https://github.com/Gargron/omniauth-mastodon)
......@@ -19,6 +19,6 @@
<hr />
<p>This website is run by <a href='https://mastodon.social/users/Gargron'>Gargron@mastodon.social</a> / <a href='https://twitter.com/Gargron'>@Gargron</a></p>
<p>This website is run by <a href='https://mastodon.social/users/Gargron'>Gargron@mastodon.social</a> / <a href='https://twitter.com/Gargron'>@Gargron</a>. <a href='https://github.com/Gargron/mastodon-bridge' target='_blank'>Source code</a></p>
</body>
</html>
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment