README.rdoc in dm-is-published-0.0.6 vs README.rdoc in dm-is-published-1.2.0
- old
+ new
@@ -9,21 +9,34 @@
== Installation
$ gem install dm-is-published
+Or add the gem to your Gemfile, and then run <tt>bundle install</tt>.
+ gem 'dm-is-published', 'CURRENT_VERSION_NUMBER'
+
+
+=== Dependencies
+
+The plugin depends upon the following:
+
+* dm-mysql-adapter OR dm-sqlite3-adapter ( >= 1.2.0)
+* data_mapper ( >= 1.2.0)
+* activesupport (>= 3.2.7) - method => Object#blank?
+
+
== Getting Started
First of all, for a better understanding of this gem, make sure you study
-the '<tt>dm-is-published/spec/integration/published_spec.rb</tt>' file.
+the '<tt>dm-is-published/spec/dm-is-published_spec.rb</tt>' file.
----
Require +dm-is-published+ in your app.
- require 'dm-core' # must be required first
+ require 'data_mapper' # must be required first
require 'dm-is-published'
Lets say we have an Article class, and each Article can have a current state,
ie: whether it's Live, Draft or an Obituary awaiting the death of someone famous (real or rumored)
@@ -88,22 +101,41 @@
end
== RTFM
-As I said above, for a better understanding of this gem/plugin, make sure you study the '<tt>dm-is-published/spec/integration/published_spec.rb</tt>' file.
+For a better understanding of this gem/plugin, make sure you study the '<tt>dm-is-select/spec/dm-is-select_spec.rb</tt>' file.
== Errors / Bugs
If something is not behaving intuitively, it is a bug, and should be reported.
Report it here: http://github.com/kematzy/dm-is-published/issues
-== Credits
-Copyright (c) 2009-07-11 [kematzy gmail com]
+== Contributing to dm-is-published
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+
+* Fork the project.
+
+* Start a feature/bugfix branch.
+
+* Commit and push until you are happy with your contribution.
+
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+
+== Copyright
+
+Copyright (c) 2009 - 2013 Kematzy.
+
Loosely based on the ActsAsPublishable plugin by [http://fr.ivolo.us/posts/acts-as-publishable]
== Licence
Released under the MIT license.
+