aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHarald Eilertsen <haraldei@anduin.net>2018-08-03 00:03:07 +0200
committerHarald Eilertsen <haraldei@anduin.net>2018-08-03 00:03:07 +0200
commitf821a8b26dbbcae679c6ca53f609f9cb04f52a47 (patch)
treea30d6088c9d733b2f9a13ba01beb8c5b40d3cb2f
parent39cbba049f53887c0305988dd6065be016a661c8 (diff)
downloadrust-zotapi-f821a8b26dbbcae679c6ca53f609f9cb04f52a47.tar.gz
rust-zotapi-f821a8b26dbbcae679c6ca53f609f9cb04f52a47.tar.bz2
rust-zotapi-f821a8b26dbbcae679c6ca53f609f9cb04f52a47.zip
Add a README while we're at it.
-rw-r--r--README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5d5af81
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+Rust implementation of the Zot API
+==================================
+
+**Note:** This project is still in very early development, and not very useful yet.
+
+The Zot protocol powers the Hubzilla social network among others. This is an implementation of the API to interact with an instance on the network.
+
+Contributing
+------------
+
+Contributions are welcome, please send patches, suggestions, bug reports etc to [zotapi-dev@volse.no](mailto::zotapi-dev@volse.no). You will also find me on [@harald@hub@volse.no](https://hub.volse.no/channel/harald), reachable through Hubzilla, ActivityPub (Mastodon++), Diaspora etc.
+
+**Code:** https://code.volse.no/zot-api.git
+
+Licence
+-------
+
+Copyright (C) 2018 Harald Eilertsen
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <https://www.gnu.org/licenses/>.