Skip to content

Commit

Permalink
Add README.md and LICENSE files
Browse files Browse the repository at this point in the history
  • Loading branch information
Arkanosis committed Apr 12, 2017
0 parents commit 0fd6ea3
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 0 deletions.
13 changes: 13 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Copyright (C) 2017 Jérémie Roquet <jroquet@arkanosis.net>

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.
40 changes: 40 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 <path to the microstatus data directory>`.

## 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 <jroquet@arkanosis.net> and licensed under the ISC license.

0 comments on commit 0fd6ea3

Please sign in to comment.