README.md in gitmodel-0.0.1 vs README.md in gitmodel-0.0.2

- old
+ new

@@ -46,10 +46,18 @@ checkout" to view and manipulate the database contents, and then "git commit" * Test-driven development and excellent test coverage * Clean and easy-to-use API +Installation +------------ + +It's available as a [RubyGem](https://rubygems.org/gems/gitmodel): + + > gem install gitmodel + + Usage ----- GitModel.db_root = '/tmp/gitmodel-data' GitModel.create_db! @@ -61,11 +69,10 @@ attribute :body attribute :categories, :default => [] attribute :allow_comments, :default => true blob :image - end p1 = Post.new(:id => 'lessons-learned', :title => 'Lessons learned', :body => '...') p1.image = some_binary_data p1.save! @@ -79,20 +86,21 @@ p3 = Post.create!(:id => 'running-with-scissors', :title => 'Running with scissors', :body => '...') p4 = Post.find('running-with-scissors') - class Comment include GitModel::Persistable attribute :text end c1 = Comment.create!(:id => '2010-01-03-328', :text => '...') c2 = Comment.create!(:id => '2010-05-29-742', :text => '...') +An example of a project that uses GitModel is [Balisong](https://github.com/pauldowman/balisong), a blogging app for coders (but it doesn't save objects to the data store. It's read-only so far, assuming that posts will be edited with a text editor). + Database file structure ----------------------- The database is stored in a human-editable format. Simply do "git checkout -f" and you'll see directories and files. @@ -123,13 +131,19 @@ * _attributes.json_ * _image_ * running-with-scissors * _attributes.json_ +Contributors +------------ +* [Paul Dowman](http://pauldowman.com/about) ([@pauldowman](http://twitter.com/pauldowman)) + + To Do ----- +* Add validations and other feature examples to sample code in README * Querying * Use AREL? * Finish some pending specs * Associations * API documentation