README.md in jsonapionify-0.0.1.pre vs README.md in jsonapionify-0.9.0
- old
+ new
@@ -1,13 +1,22 @@
# JSONAPIonify
-[![Version](http://allthebadges.io/brandfolder/jsonapionify/badge_fury.png)](http://allthebadges.io/brandfolder/jsonapionify/badge_fury)
+[![Gem Version](https://badge.fury.io/rb/jsonapionify.svg)](https://badge.fury.io/rb/jsonapionify)
[![Build Status](https://travis-ci.org/brandfolder/jsonapionify.svg?branch=master)](https://travis-ci.org/brandfolder/jsonapionify)
[![Code Climate](https://codeclimate.com/repos/5672446f137f95309c0067c6/badges/a369f0a182ce111c8fcd/gpa.svg)](https://codeclimate.com/repos/5672446f137f95309c0067c6/feed)
[![Test Coverage](https://codeclimate.com/repos/5672446f137f95309c0067c6/badges/a369f0a182ce111c8fcd/coverage.svg)](https://codeclimate.com/repos/5672446f137f95309c0067c6/coverage)
-TODO: Write Description
+JSONAPIonify is a framework for building JSONApi 1.0 compliant
+APIs. It can run as a standalone rack app or as part of a larger framework such
+as rails. In addition, it auto-generates beautiful documentation.
+Live Example:
+
+* [Resource](https://api.brandfolder.com/v2/slug/brandfolder)
+* [Documentation](https://api.brandfolder.com/v2/docs) (screenshot below)
+
+ [![Documentation Example](https://api.url2png.com/v6/P3CAE278FC306AA/50ef2ba09c77f6fb25dd7f179de2a704/png/?thumbnail_max_width=500&url=https%3A%2F%2Fapi.brandfolder.com%2Fv2%2Fdocs)](https://api.brandfolder.com/v2/docs)
+
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -16,17 +25,14 @@
And then execute:
$ bundle
-Or install it yourself as:
-
- $ gem install jsonapionify
-
## Usage
-TODO: Write usage instructions here
+Refer to the [wiki](https://github.com/brandfolder/jsonapionify/wiki) for detailed
+information on how to use the framework.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -38,6 +44,5 @@
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-