diff --git a/README.md b/README.md index c9c9a1b..0ec53fa 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,33 @@ # 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) [![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) [![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) -[![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) | -[Project site](https://diasporafoundation.org) | -[Wiki](https://wiki.diasporafoundation.org) | +[Documentation](http://www.rubydoc.info/gems/diaspora_federation/) | [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 This gem is published under the terms of the "GNU Affero General Public License". See the LICENSE file for the exact wording.