Browse files

Updated docs

  • Loading branch information...
1 parent abccc3b commit 18f53fe361bea093566e0299a1af5feb0f630f67 @joost committed Aug 22, 2011
Showing with 21 additions and 6 deletions.
  1. +21 −6 README.rdoc
  2. BIN doc/screenshot.png
View
27 README.rdoc
@@ -1,20 +1,27 @@
= AdminInterface
-A Rails admin interface generator for Rails 3. Theme stolen from Redmine. Similar to web-app-theme.
+A Rails admin interface generator for Rails 3.1+. Theme stolen from Redmine. Similar to web-app-theme.
== More info
-Generator to create some nifty admin scaffolds. It can work with SearchLogic and WillPaginate.
+Generator to create some nifty admin scaffolds. It can work with MetaSearch and Kaminari.
It also has admin authentication really well implemented.
== Install
+=== Rails 3.1
+
+You should be using v1.2.0+.
+
+ gem "admin_interface"
+
+=== Earlier Rails Versions
+
+If you're using Rails 3.0 or earlier use
+
Add following to your Gemfile
- group :development, :test do
- # Generators
- gem 'admin_interface'
- end
+ gem "admin_interface", "~> 1.0.0"
AdminInterface uses several gems. So put these in your Gemfile
@@ -71,10 +78,18 @@ Attribute pairs are column_name:sql_type arguments specifying the
model's attributes. Timestamps are added by default, so you don't have to
specify them by hand as 'created_at:datetime updated_at:datetime'.
+=== Customize
+
+You should customize your admin area so it can be more functional and nicely looking.
+
=== See it in action
Go to /admin and you can see everything in action.
+== Screenshot
+
+https://raw.github.com/joost/admin_interface/master/doc/screenshot.png
+
== Error messages
Add this to a initializer or in your environment.rb (see: http://railscasts.com/episodes/39-customize-field-error)
View
BIN doc/screenshot.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 18f53fe

Please sign in to comment.