diff --git a/README.md b/README.md index 1eaee56..8edc4b9 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,27 @@ -# knock [![Build Status](https://travis-ci.org/nsarno/knock.svg)](https://travis-ci.org/nsarno/knock) [![Test Coverage](https://codeclimate.com/github/nsarno/knock/badges/coverage.svg)](https://codeclimate.com/github/nsarno/knock/coverage) [![Code Climate](https://codeclimate.com/github/nsarno/knock/badges/gpa.svg)](https://codeclimate.com/github/nsarno/knock) [![security](https://hakiri.io/github/nsarno/knock/master.svg)](https://hakiri.io/github/nsarno/knock/master) +# knock +[![Gem Version](https://badge.fury.io/rb/knock.svg)](http://badge.fury.io/rb/knock) +[![Build Status](https://travis-ci.org/nsarno/knock.svg)](https://travis-ci.org/nsarno/knock) +[![Test Coverage](https://codeclimate.com/github/nsarno/knock/badges/coverage.svg)](https://codeclimate.com/github/nsarno/knock/coverage) +[![Code Climate](https://codeclimate.com/github/nsarno/knock/badges/gpa.svg)](https://codeclimate.com/github/nsarno/knock) +[![security](https://hakiri.io/github/nsarno/knock/master.svg)](https://hakiri.io/github/nsarno/knock/master) Seamless JWT authentication for Rails API ## Description -Knock is a [rails engine](http://guides.rubyonrails.org/engines.html). It provides an authentication solution for Rails API only application based on JSON Web Tokens ([JWT](http://jwt.io/)). +Knock is a [rails engine](http://guides.rubyonrails.org/engines.html) providing an authentication solution for Rails API only application based on JSON Web Tokens ([JWT](http://jwt.io/)). + +### Why should I use this? + +- It's lightweight. +- It's tailored for Rails API-only application. +- It's [stateless](https://en.wikipedia.org/wiki/Representational_state_transfer#Stateless). + +### Is this gem going to be maintained? + +Yes. + +We're using it in our own apps, and we'll keep improving it. ## Getting Started @@ -80,6 +97,10 @@ GET /myresources To enable cross-origin resource sharing, check out the [rack-cors](https://github.com/cyu/rack-cors) gem. +### Related links + +- [10 things you should know about tokens](https://auth0.com/blog/2014/01/27/ten-things-you-should-know-about-tokens-and-cookies/) + ## Contributing 1. Fork it ( https://github.com/[my-github-username]/mygem/fork )