Merge branch 'master' of https://github.com/onozaty/redmine-view-customize

Author: onozaty

README.md

@@ -3,6 +3,12 @@ Redmine view customize plugin
 
 This a plugin allows you to customize the view for the [Redmine](http://www.redmine.org).
 
+Features
+------------
+
+By adding JavaScript or CSS to the matched path, a screen is made customizable. 
+
+
 Installation
 ------------
 
@@ -13,6 +19,26 @@ Install the plugin in your Redmine plugins directory, clone this repository as `
     cd ../
     rake redmine:plugins:migrate
 
+Usage
+------------
+
+### Setting
+
+1. After you install the Plugin, "View customize" the administrator menu is added.
+![Screenshot of admin menu](screenshots/admin.png)
+![Screenshot of list](screenshots/list_new.png)
+2. Add a new setting.
+![Screenshot of new](screenshots/new.png)
+3. Path pattern is specified with a regular expression. (ex. /issues/[0-9]+)
+If there is a match with the path of the page, the code(JavaScript/StyleSheet) is executed.
+![Screenshot of new path pattern](screenshots/new_pathpattern.png)
+4. Input code.
+![Screenshot of new JavaScript](screenshots/new_javascript.png)
+![Screenshot of new StyleSheet](screenshots/new_stylesheet.png)
+5. Matches the path, StyleSheet or JavaScrpt is embedded, the screen display is changed.
+![Screenshot of view JavaScript](screenshots/view_javascript.png)
+![Screenshot of view StyleSheet](screenshots/view_stylesheet.png)
+
 Supported versions
 ------------------