From 0fd6ea3136695ab7ac305cded3073e117b8d8f60 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=A9mie=20Roquet?= Date: Wed, 12 Apr 2017 02:32:03 +0200 Subject: [PATCH] Add README.md and LICENSE files --- LICENSE | 13 +++++++++++++ README.md | 40 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 53 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0c0801b --- /dev/null +++ b/LICENSE @@ -0,0 +1,13 @@ +Copyright (C) 2017 Jérémie Roquet + +Permission to use, copy, modify, and/or distribute this software for any +purpose with or without fee is hereby granted, provided that the above +copyright notice and this permission notice appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY +SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER +RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, +NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE +USE OR PERFORMANCE OF THIS SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..c32b671 --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +# microstatus [![License](http://img.shields.io/badge/license-ISC-blue.svg)](/LICENSE) + +**microstatus** is a lightweight [Mastodon](https://github.com/tootsuite/mastodon)- and [GNU social](https://gnu.io/social/)-compatible [OStatus](https://www.w3.org/community/ostatus/) server implementation. + +## Design goals + +microstatus aims at the following objectives: +* provide a complete, standard compliant implementation of the OStatus protocol; +* be extremely lightweight, self-contained and easy to deploy; +* federate with Mastodon and GNU social instances (at least); +* use a hackable, UNIX-friendly storage format; +* come with a nice client API. + +microstatus (nice to have) non-goals include: +* providing a *scalable* implementation of the OStatus protocol; +* handling billions of users; +* being compatible with Mastodon's, GNU social's or Twitter's *client* API; +* coming with a nice web or mobile UI. + +## Compilation + +Run `cargo build --release` in your working copy. + +## Installation + +Copy the `microstatus` binary wherever you want. + +## Usage + +Run `microstatus `. + +## Contributing and reporting bugs + +Contributions are welcome through [GitHub pull requests](https://github.com/Arkanosis/microstatus/pulls). + +Please report bugs and feature requests on [GitHub issues](https://github.com/Arkanosis/microstatus/issues). + +## License + +microstatus is copyright (C) 2017 Jérémie Roquet and licensed under the ISC license.