README.md in json_model-0.1.1 vs README.md in json_model-0.1.2

- old
+ new

@@ -1,9 +1,18 @@ -# JsonModel +# Json Model Simple persist your model data to a .json file +| Project | | +|------------------------ | ----------------- | +| gem name | json_model | +| license | [MIT][license] | +| version | [![Gem Version](https://badge.fury.io/rb/json_model.png)](http://badge.fury.io/rb/json_model) | +| continuous integration | [![Build Status](https://secure.travis-ci.org/endorfin/json_model.png?branch=master)](https://travis-ci.org/endorfin/json_model) | +| test coverage | [![Coverage Status](https://coveralls.io/repos/endorfin/json_model/badge.svg)](https://coveralls.io/r/endorfin/json_model) +| homepage | [https://github.com/endorfin/json_model][homepage] | + ## Installation Add this line to your application's Gemfile: ```ruby @@ -18,56 +27,64 @@ $ gem install json_model ## Usage -book.rb +```ruby +require 'json_model' - require 'json_model' +class Book + include JsonModel - class Book - include JsonModel + field :name + field :author +end - field :name - field :author - end +# create some books +Book.new({name: 'Inferno', author: 'Dan Brown'}).save +Book.new({name: 'Das verlorene Symbol', author: 'Dan Brown'}).save +Book.new({name: 'Diabolus', author: 'Dan Brown'}).save - # create some books - Book.new({name: 'Inferno', author: 'Dan Brown'}).save - Book.new({name: 'Das verlorene Symbol', author: 'Dan Brown'}).save - Book.new({name: 'Diabolus', author: 'Dan Brown'}).save +# list all books +puts "\n--- List all books" +Book.all.map{|book| puts "#{book.id} - #{book.name} by #{book.author}" } - # list all books - puts "\n--- List all books" - Book.all.map{|book| puts "#{book.id} - #{book.name} by #{book.author}" } +# find a book by id +puts "\n--- Find book with id=1" +book = Book.find(1) +puts "Book: #{book.to_json}" - # find a book by id - puts "\n--- Find book with id=1" - book = Book.find(1) - puts "Book: #{book.to_json}" +# update a book +puts "\n--- Update name of book with id=1" +book = Book.find(1) +book.name = 'Illuminati' +book.save +Book.all.map{|book| puts "#{book.id} - #{book.name} by #{book.author}" } - # update a book - puts "\n--- Update name of book with id=1" - book = Book.find(1) - book.name = 'Illuminati' - book.save - Book.all.map{|book| puts "#{book.id} - #{book.name} by #{book.author}" } +# find a book by name +puts "\n--- Find book by name 'Illuminati'" +book = Book.find_by(name: 'Illuminati') +puts "Book: #{book.to_json}" - # find a book by name - puts "\n--- Find book by name 'Illuminati'" - book = Book.find_by(name: 'Illuminati') - puts "Book: #{book.to_json}" +# delete a book +puts "\n--- Delete book with Id=2" +book = Book.find(2) +book.destroy +Book.all.map{|book| puts "#{book.id} - #{book.name} by #{book.author}" } +``` - # delete a book - puts "\n--- Delete book with Id=2" - book = Book.find(2) - book.destroy - Book.all.map{|book| puts "#{book.id} - #{book.name} by #{book.author}" } + $ ruby book.rb +## License +[MIT License][license] + +[license]: https://github.com/endorfin/json_model/blob/master/MIT-LICENSE +[homepage]: https://github.com/endorfin/json_model + ## Contributing -1. Fork it ( https://github.com/[my-github-username]/json_model/fork ) +1. Fork it ( https://github.com/endorfin/json_model/fork ) 2. Create your feature branch (`git checkout -b my-new-feature`) 3. Commit your changes (`git commit -am 'Add some feature'`) 4. Push to the branch (`git push origin my-new-feature`) 5. Create a new Pull Request