about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorEugen Rochko <eugen@zeonfederated.com>2016-02-23 13:08:01 +0100
committerEugen Rochko <eugen@zeonfederated.com>2016-02-23 13:08:01 +0100
commit3b0bc18db928c455186273d9b9aa5b96d91e035e (patch)
treea372d4506ace34debd9cf500a597bc27ecb74705 /README.md
parent2bc48e9064c56101d1761a10d8c5badba60d2bbe (diff)
Improved Atom rendering templates, added README
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..ce820af34
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+Mastodon
+========
+
+Mastodon is a federated microblogging engine. An alternative implementation of the GNU Social project. Based on ActivityStreams, Webfinger, PubsubHubbub and Salmon.
+
+The core ideals of this project are:
+
+- Independence of legacy Twitter APIs - we don't want to be compatible with Twitter clients, we want our own clients
+- In that vein, a strong and clean REST API and OAuth2
+- Minimalism. Just because you can do almost anything with ActivityStreams doesn't mean you should. Limit the set of possible functions to what makes sense in a microblogging engine. This will make federation as well as UI design a lot easier
+- Ease of deployment. The end-goal of this project is to be distributable as a Docker image.
+
+**Current status of the project is early development. Documentation, licensing information &co will be added later**