README.md in imagine-0.1.3 vs README.md in imagine-0.1.4
- old
+ new
@@ -4,10 +4,25 @@
A rails image gallery, that's mountable. Works on rails 3.1 at least :)
It's still in active development.
* [Github project](http://www.github.com/knewter/imagine)
+## USAGE
+To use Imagine in your app, simply add it to your Gemfile. Then, mount it by:
+
+ mount Imagine::Engine, :at => "/imagine"
+
+Install the migrations with:
+
+ bundle exec rake imagine:install:migrations
+
+And run the migrations with:
+
+ bundle exec rake db:migrate
+
+Finally, visit /imagine/albums in your browser to get started.
+
## TODO
* Build the plugin system
* Build a plugin that ships with core that handles a basic display style
* Allow a user to choose the default display style at album level
* Allow a visitor to look at any album with any display style via a param
@@ -38,5 +53,6 @@
## Contributors
Josh Adams (josh@isotope11.com)
Some code (plugin system, .travis.yml) lifted ungraciously from http://github.com/resolve/refinerycms. Those guys are awesome.
+