Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Joost Hietbrink committed Aug 22, 2011
1 parent abccc3b commit 18f53fe
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 6 deletions.
27 changes: 21 additions & 6 deletions README.rdoc
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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)
Expand Down
Binary file added doc/screenshot.png
Loading
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.