aboutsummaryrefslogtreecommitdiffstats
path: root/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md28
1 files changed, 23 insertions, 5 deletions
diff --git a/readme.md b/readme.md
index 32bf487..1f1ad5c 100644
--- a/readme.md
+++ b/readme.md
@@ -2,7 +2,7 @@
Simple blog engine for [Refinery CMS](http://refinerycms.com). It supports posts, categories and comments.
-This version of `refinerycms-blog` supports Rails 3.0.x. To use Rails 2.3.x use the [refinerycms-blog "Rails 2.3.x stable branch"](http://github.com/resolve/refinerycms-blog/tree/rails2-stable).
+This version of `refinerycms-blog` supports Rails 3.1.x. To use Rails 2.3.x use the [refinerycms-blog "Rails 2.3.x stable branch"](http://github.com/resolve/refinerycms-blog/tree/rails2-stable).
Options:
@@ -11,20 +11,38 @@ Options:
## Requirements
-Refinery CMS version 1.0.0 or above.
+Refinery CMS version 2.0.0 or above.
## Install
Open up your ``Gemfile`` and add at the bottom this line:
- gem 'refinerycms-blog', '~> 1.6.1'
+ gem 'refinerycms-blog', '~> 2.0.0'
Now, run ``bundle install``
Next, to install the blog plugin run:
- rails generate refinerycms_blog
+ rails generate refinery:blog
Finally migrate your database and you're done.
- rake db:migrate \ No newline at end of file
+ rake db:migrate
+
+## Developing & Contributing
+
+The version of Refinery to develop this engine against is defined in the gemspec. To override the version of refinery to develop against, edit the project Gemfile to point to a local path containing a clone of refinerycms.
+
+### Testing
+
+Generate the dummy application to test against
+
+ $ bundle exec rake refinery:testing:dummy_app
+
+Run the test suite with [Guard](https://github.com/guard/guard)
+
+ $ bundle exec guard start
+
+Or just with rake spec
+
+ $ bundle exec rake spec