README.md in cadenero-0.0.2.a3 vs README.md in cadenero-0.0.2.b1
- old
+ new
@@ -4,11 +4,10 @@
[![Gem Version](https://fury-badge.herokuapp.com/rb/cadenero.png)](http://badge.fury.io/rb/cadenero)
[![Build Status](https://travis-ci.org/AgilTec/cadenero.png?branch=master)](https://travis-ci.org/AgilTec/cadenero)
[![Code Climate](https://codeclimate.com/github/AgilTec/cadenero.png)](https://codeclimate.com/github/AgilTec/cadenero)
[![Coverage Status](https://coveralls.io/repos/AgilTec/cadenero/badge.png?branch=master)](https://coveralls.io/r/AgilTec/cadenero?branch=master)
[![Dependency Status](https://gemnasium.com/AgilTec/cadenero.png)](https://gemnasium.com/AgilTec/cadenero)
-[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/AgilTec/cadenero/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
Authentication Engine for Rails.API multitenant RESTful APIs based on Warden. It:
* Is Racked based
* Use token authentication as strategy for the API
* Is RESTful API
@@ -26,11 +25,11 @@
$ rails-api new your_app --skip-test-unit
```
In the `Gemfile` add the following lines:
```ruby
- gem 'cadenero', '~> 0.0.2.a3'
+ gem 'cadenero', '~> 0.0.2.b1'
gem 'pg'
```
In the `config/database.yml` replace the `sqlite3` adapter for `postgresql` as follow:
@@ -108,13 +107,15 @@
You can check them running:
```
rake routes
```
+### Documentation
+You can review the YARD docs in: http://rubydoc.info/github/AgilTec/cadenero/frames
### The Cadenero Task List
- [x] Specs for the code 100% Coverage using BDD with [Rspec](https://github.com/rspec/rspec) and [Capybara](https://github.com/jnicklas/capybara)
-- [ ] Documatation for all the code
+- [x] Documatation for all the code
- [ ] Examples of use and demo
### Versions
**Cadenero** use [Semantic Versioning 2.0.0](http://semver.org/) the current version is: 0.0.2-alpha meaning MAJOR.MINOR.PATCH format
\ No newline at end of file