update readme

This commit is contained in:
Benjamin Neff 2015-07-01 20:36:47 +02:00
parent e7144a6db9
commit 3354eb472b

View file

@ -1,19 +1,33 @@
# diaspora* federation rails engine # diaspora* federation rails engine
#### A rails engine that adds the diaspora* federation protocol to a rails app **A rails engine that adds the diaspora* federation protocol to a rails app**
[![Build Status](https://travis-ci.org/SuperTux88/diaspora_federation.svg?branch=master)](https://travis-ci.org/SuperTux88/diaspora_federation) [![Build Status](https://travis-ci.org/SuperTux88/diaspora_federation.svg?branch=master)](https://travis-ci.org/SuperTux88/diaspora_federation)
[![Code Climate](https://codeclimate.com/github/SuperTux88/diaspora_federation/badges/gpa.svg)](https://codeclimate.com/github/SuperTux88/diaspora_federation) [![Code Climate](https://codeclimate.com/github/SuperTux88/diaspora_federation/badges/gpa.svg)](https://codeclimate.com/github/SuperTux88/diaspora_federation)
[![Test Coverage](https://codeclimate.com/github/SuperTux88/diaspora_federation/badges/coverage.svg)](https://codeclimate.com/github/SuperTux88/diaspora_federation/coverage) [![Test Coverage](https://codeclimate.com/github/SuperTux88/diaspora_federation/badges/coverage.svg)](https://codeclimate.com/github/SuperTux88/diaspora_federation/coverage)
[![Dependency Status](https://gemnasium.com/SuperTux88/diaspora_federation.svg)](https://gemnasium.com/SuperTux88/diaspora_federation) [![Dependency Status](https://gemnasium.com/SuperTux88/diaspora_federation.svg)](https://gemnasium.com/SuperTux88/diaspora_federation)
[![Inline docs](https://inch-ci.org/github/SuperTux88/diaspora_federation.svg?branch=master)](https://inch-ci.org/github/SuperTux88/diaspora_federation) [![Inline docs](https://inch-ci.org/github/SuperTux88/diaspora_federation.svg?branch=master)](https://inch-ci.org/github/SuperTux88/diaspora_federation)
[![Gem Version](https://badge.fury.io/rb/diaspora_federation.svg)](http://badge.fury.io/rb/diaspora_federation) [![Gem Version](https://badge.fury.io/rb/diaspora_federation.svg)](https://badge.fury.io/rb/diaspora_federation)
[Documentation](http://www.rubydoc.info/github/SuperTux88/diaspora_federation/master) | [Documentation](http://www.rubydoc.info/gems/diaspora_federation/) |
[Project site](https://diasporafoundation.org) |
[Wiki](https://wiki.diasporafoundation.org) |
[Bugtracker](https://github.com/SuperTux88/diaspora_federation/issues) [Bugtracker](https://github.com/SuperTux88/diaspora_federation/issues)
## Development
**!!! This gem is currently under heavy development, so every release can contain breaking changes !!!**
If you want to help, please contact me, help is welcome.
After the first stable release, this repo will be moved to the [diaspora organization](https://github.com/diaspora/).
## Diaspora
a privacy-aware, distributed, open source social network
Links:
[Project site](https://diasporafoundation.org) |
[Wiki](https://wiki.diasporafoundation.org)
## License ## License
This gem is published under the terms of the "GNU Affero General Public License". See the LICENSE file for the exact wording. This gem is published under the terms of the "GNU Affero General Public License". See the LICENSE file for the exact wording.