:plugin_name

:plugin_description

Note: Replace :author_name :author_username :plugin_name :plugin_identifier :plugin_description :codeclimate_id with their correct values, then delete this line.

:plugin_description

Compatibility

This plugin version is compatible only with Redmine 3.4 and later.

Installation

1. Download the .ZIP archive, extract files and copy the plugin directory to #{REDMINE_ROOT}/plugins/:plugin_identifier.

2. From the directory #{REDMINE_ROOT}, install the plugin's dependencies:

   bundle install

3. Make a backup of your database, then run the following command to update it:

   bundle exec rake redmine:plugins:migrate NAME=:plugin_identifier RAILS_ENV=production

4. Restart Redmine.

Uninstall

1. Make a backup of your database, then rollback the migrations:

   bundle exec rake redmine:plugins:migrate NAME=:plugin_identifier VERSION=0 RAILS_ENV=production

2. Remove the plugin's folder from #{REDMINE_ROOT}/plugins.

3. Restart Redmine.

Usage

Explain how to use your package.

Testing

Run tests using the following command:

bundle exec rake redmine:plugins:test NAME=:plugin_identifier RAILS_ENV=development

Contributing

Please see CONTRIBUTING and CODE OF CONDUCT for details.

Security

If you discover any security related issues, please email security@exolnet.com instead of using the issue tracker.

Credits

• :author_name
• All Contributors

License

Copyright © eXolnet. All rights reserved.

This code is licensed under the MIT license. Please see the license file for more information.