add README.md for github

This commit is contained in:
Benjamin Neff 2015-06-11 03:38:50 +02:00
parent 710e54ade2
commit a1f74c1770
4 changed files with 19 additions and 7 deletions

16
README.md Normal file
View file

@ -0,0 +1,16 @@
# diaspora* federation rails engine
#### 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)
[Project site](https://diasporafoundation.org) |
[Wiki](https://wiki.diasporafoundation.org) |
[Bugtracker](http://github.com/SuperTux88/diaspora_federation/issues)
## License
This gem is published under the terms of the "GNU Affero General Public License". See the LICENSE file for the exact wording.

View file

@ -1,3 +0,0 @@
= DiasporaFederation
This project rocks and uses LICENSE.

View file

@ -10,7 +10,6 @@ RDoc::Task.new(:rdoc) do |rdoc|
rdoc.rdoc_dir = "rdoc"
rdoc.title = "DiasporaFederation"
rdoc.options << "--line-numbers"
rdoc.rdoc_files.include("README.rdoc")
rdoc.rdoc_files.include("lib/**/*.rb")
end

View file

@ -10,11 +10,11 @@ Gem::Specification.new do |s|
s.authors = ["Benjamin Neff"]
s.email = ["benjamin@coding4.coffee"]
s.homepage = "https://github.com/SuperTux88/diaspora_federation"
s.summary = "Diaspora Federation Rails Engine"
s.description = "A rails engine that adds the diaspora federation protocol to a rails app"
s.summary = "diaspora* federation rails engine"
s.description = "A rails engine that adds the diaspora* federation protocol to a rails app"
s.license = "AGPL 3.0 - http://www.gnu.org/licenses/agpl-3.0.html"
s.files = Dir["{app,config,db,lib}/**/*", "LICENSE", "Rakefile", "README.rdoc"]
s.files = Dir["{app,config,db,lib}/**/*", "LICENSE", "Rakefile", "README.md"]
s.test_files = Dir["test/**/*"]
s.add_dependency "rails", "~> 4.2.1"