README.md in ninsho-0.1.0 vs README.md in ninsho-0.1.1
- old
+ new
@@ -6,11 +6,11 @@
* Works with most providers out there, Github, Facebook, Twitter, Linkedin
## Getting started
-Ninsho 0.0.1 works with rails 3.1 onwards. You can add it to your Gemfile with:
+Ninsho 0.1.0 works with rails 3.1 onwards. You can add it to your Gemfile with:
```ruby
gem 'ninsho'
```
@@ -119,24 +119,27 @@
So if you need to add an extra field to your ninsho model (commonly 'Authentication'), it's as easy as adding a ```before_save``` callback and handle the extra stuff by yourself. Don't get it?, here ir a quick example:
Let's say we want to save the nickname from the hash into our ninsho model:
-1. Add the migration to the ninsho model
- ```console
- rails g migration add_nickname_to_MODEL nickname:string
- ```
-2. Run the migration and add the callback which should look like:
+i. Add the migration to the ninsho model
+
+```console
+rails g migration add_nickname_to_MODEL nickname:string
+```
+ii. Run the migration and add the callback which should look like:
+
```ruby
before_save :set_nickname
```
+
```ruby
def set_nickname
self.nickname = self.auth_hash.info.nickname
end
```
-3. You are good to go, and any time the user changes the nickname yours will too!
+iii. You are good to go, and any time the user changes the nickname yours will too!
### I18n
You can overwrite the ninsho locale and customize the flash messages:
@@ -144,20 +147,26 @@
```yaml
en:
ninsho:
sessions:
signed_in: "Signed in successfully"
- signed_out: "Signed out successfully"
+ signed_out: "Signed out successfully"
```
+###Psst! Here is a live example in rails
+
+[Rails ninsho example](https://github.com/IcaliaLabs/ninsho_example)
+
### Changelog
-* Current gem version 0.0.3
+* Current gem version 0.1.0
* Add more documentation on code
* Add aouth token for Facebook friends
* Add more flexibility to handle authentications and save to multiple fields
* Add handy helpers
+* Add rails live example
+* Released gem version 0.0.3
* Released gem version 0.0.2
* Released gem version 0.0.1
### Devs
@@ -166,10 +175,10 @@
### Future
* Add tests
* Support for Mongoid
* Add wiki
-* Add rails live example
+
## Credits
Icalia Labs - weare@icalialabs.com