Skip to content

Commit

Permalink
updated the readme to include information about the new authenticatio…
Browse files Browse the repository at this point in the history
…n stuff -- fixes jejacks0n#106
  • Loading branch information
jejacks0n committed Jan 1, 2012
1 parent 174ac3f commit 6a761ef
Showing 1 changed file with 17 additions and 6 deletions.
23 changes: 17 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,16 +100,19 @@ Include the gem in your Gemfile and bundle to install the gem.

gem 'mercury-rails'

Make sure you get the migrations that you'll need.

rake mercury_engine:install:migrations
rake db:migrate

You can also get the configuration file, css, and routes by running the generator.

rails generate mercury:install

This generator puts the mercury base file (configuration) into your project in /app/assets/javascripts/mercury.js.
This generator puts the mercury base file (configuration) into your project in /app/assets/javascripts/mercury.js,
and includes the base mercury routes. It can optionally install the layout and a css overrides file, as well as an
authentication helper that allows you to restrict access to editing.

Make sure you get the migrations that you'll need for image uploading (if not you can disable the feature in
mercury.js).

rake mercury_engine:install:migrations
rake db:migrate


## Usage
Expand Down Expand Up @@ -265,6 +268,14 @@ I'm interested in what solutions people are looking for and end up using for thi
you write something (eg. a middleware layer, an nginx module, or just something simple to get the job done).


## Adding Authentication

When you install Mercury using the generator (`rails g mercury:install`) you can optionally install an authentication
file into your application (at `lib/mercury/authentication.rb`). This is a simple method for restricting the actions in
the MercuryController to only users who have the required privileges. Since this can vary largely from application to
application, it's a basic approach that lets you write in what you want.


## Project Details

### WYSIWYG Editors Suck
Expand Down

0 comments on commit 6a761ef

Please sign in to comment.