Skip to content

Commit

Permalink
Update readme for vrsion 0.0.5.
Browse files Browse the repository at this point in the history
  • Loading branch information
akiko-pusu committed Apr 5, 2012
1 parent 8371183 commit d2890a1
Showing 1 changed file with 31 additions and 4 deletions.
35 changes: 31 additions & 4 deletions README.rdoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,51 @@ Plugin to show site-wide message from site administrator, such as maintenacne in
=== Plugin installation

1. Copy the plugin directory into the vendor/plugins directory.
2. (Re)Start Redmine.
2. Do migration task. (e.g. rake db:migrate_plugins RAILS_ENV=production)
3. (Re)Start Redmine.

Corrently migration task is not required.
Version 0.0.5 later, migration is required.

=== Usage
=== Uninstall

Do following command:

* rake db:migrate_plugins NAME=redmine_banner VERSION=0 RAILS_ENV=production

=== Usage for site wide banner

1. Go to plugin's page and click "Settings" link of Redmine Banner Plugin.
You can edit banner message and select style for message.
Also You can access setting page from administration menu, click "banner" icon.

=== Usage for project scope banner

1. Banner can use as project module.
If you want to manage the banner for your project, "Manage Banner" permission is required
to your role.

2. Go to project settings tab and check "Banner" as project module.
3. Then you can see "Banner" tab on project settings page.

=== Current restrictions

1. Banner for each project does not support timer.
2. Banner for each project is located at the top of the project only. (Not support footer)
3. To render banner, javascript (prototype.js) is required and banner will not be shown correctly
if you does not use modern browser.

=== Note

To use this plugin previous version (1.xx, 1.0.x...), please see this instruction.
https://github.com/akiko-pusu/redmine_banner/wiki/How-to-use-this-plugin-previous-version-(1.xx,-1.0.x...)

== Changelog

=== 0.0.5

* Support banner for each project.
Thak you so much, Denny Schäfer, Haru Iida.

=== 0.0.4

* Support timer function.
Expand Down Expand Up @@ -52,7 +80,6 @@ Corrently migration task is not required.

* http://www.r-labs.org/projects/banner (Project Page)


=== License

This software is licensed under the GNU GPL v2. See COPYRIGHT and COPYING for details.

0 comments on commit d2890a1

Please sign in to comment.