mince 0.0.2 → 0.0.3

data/.gitignore

@@ -1 +1,5 @@
+*.gem
 .idea
+.bundle
+Gemfile.lock
+pkg/*

data/README.md

@@ -1,16 +1,53 @@
-# What is this?
+# What is mince?
 
-Provides a very lightweight interface to store and retrieve data in MongoDB in Ruby.
+Light weight ORM to persist data to a hash. 
+
+Provides a very light weight interface for storing and retreiving information to MongoDB.
+
+The motivation behind this is so your application is not tightly tied to a specific database.  As your application grows you may need to upgrade to a different database or pull specific models to a different persistence strategy.
+
+[@github](https://github.com/asynchrony/mince)
+[@rubygems](https://rubygems.org/gems/mince)
+
+# How to use
+
+view the [example mince rails app](https://github.com/coffeencoke/mince_rails_example) to see how to use this.
+
+Start MongoDB at localhost (currently does not support authentication against MongoDB).
+
+From there you can use Mince to add and retrieve data.
+
+<pre>
+# Add a book to the books collection
+Mince::DataStore.add 'books', title: 'The World In Photographs', publisher: 'National Geographic'
+
+# Retrieve all records from the books collection
+Mince::DataStore.find_all 'books'
+
+# Retrieve all records from the books collection
+Mince::DataStore.find_all 'books'
+
+# Replace the a specific book
+Mince::DataStore.replace 'books', title: 'A World In Photographs', publisher: 'National Geographic'
+</pre>
+
+View the [data_store.rb](https://github.com/asynchrony/mince/blob/master/lib/mince/data_store.rb) file for all methods available.
+
+Use with [mince data model](https://github.com/asynchrony/mince_data_model) to make it easy to change from one data storage to another, like [Hashy Db](https://github.com/asynchrony/hashy_db), a Hash data persistence implementation.
 
 # Why would you want this?
 
-- To build a non-active-record implementation application using MongoDB.
-- Allows interchanging data persistence with HashyDb
+- To defer choosing your database until you know most about your application.
+- Provides assitance in designing a database agnostic architecture.
+- When used along with [Hashy Db](https://github.com/asynchrony/hashy_db) it offers very little technical dependencies.  Use Hashy Db in development mode so that you can clone the repo and develop, and run tests, cucumbers without databases, migrations, etc.  Then in production mode, switch to Mince.
+
+If you are able to switch between Hashy Db and Mince, your application will be more open to new and improved database in the future, or as your application evolves you aren't tied to a database.
 
-# Todos
 
-- Make an example rails app that utilizes this gem
-- Add a better readme
+# Todo
+
+- Load configuration from a yaml file
+- Add rdoc comments
 
 # Contribute
 
@@ -19,8 +56,11 @@ Provides a very lightweight interface to store and retrieve data in MongoDB in R
 # Owners
 
 Matt Simpson - [@railsgrammer](https://twitter.com/railsgrammer)
-<br />
+
 Jason Mayer - [@farkerhaiku](https://twitter.com/farkerhaiku)
 
 # Contributors
-- Your name here!
+
+- Your name here!
+
+![Mince Some App](https://github.com/coffeencoke/gist-files/raw/master/images/mince%20garlic.png)

data/lib/mince/version.rb

@@ -1,3 +1,3 @@
 module Mince
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mince
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -15,7 +15,7 @@ date: 2012-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70168102098280 !ruby/object:Gem::Requirement
+  requirement: &70236892657660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -23,10 +23,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70168102098280
+  version_requirements: *70236892657660
 - !ruby/object:Gem::Dependency
   name: mongo
-  requirement: &70168102097760 !ruby/object:Gem::Requirement
+  requirement: &70236892657120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -34,10 +34,10 @@ dependencies:
         version: 1.5.2
   type: :runtime
   prerelease: false
-  version_requirements: *70168102097760
+  version_requirements: *70236892657120
 - !ruby/object:Gem::Dependency
   name: bson_ext
-  requirement: &70168102097220 !ruby/object:Gem::Requirement
+  requirement: &70236892656620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -45,10 +45,10 @@ dependencies:
         version: 1.5.2
   type: :runtime
   prerelease: false
-  version_requirements: *70168102097220
+  version_requirements: *70236892656620
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70168102096840 !ruby/object:Gem::Requirement
+  requirement: &70236892656140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,10 +56,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70168102096840
+  version_requirements: *70236892656140
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70168102096180 !ruby/object:Gem::Requirement
+  requirement: &70236892655480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,7 +67,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70168102096180
+  version_requirements: *70236892655480
 description: Lightweight MongoDB ORM for Ruby.
 email:
 - matt@railsgrammer.com