readme update

README.md

@@ -1,17 +1,14 @@
-Sudo plugin for Redmine
-==================================
+# Sudo plugin for Redmine
 
 [![Rate at redmine.org](https://img.shields.io/badge/rate%20at-redmine.org-blue.svg?style=flat)](https://www.redmine.org/plugins/redmine_sudo) [![Run Linters](https://github.com/AlphaNodes/redmine_sudo/workflows/Run%20Linters/badge.svg)](https://github.com/AlphaNodes/redmine_sudo/actions?query=workflow%3A%22Run+Linters%22) [![Run Brakeman](https://github.com/AlphaNodes/redmine_sudo/workflows/Run%20Brakeman/badge.svg)](https://github.com/AlphaNodes/redmine_sudo/actions?query=workflow%3A%22Run+Brakeman%22) [![Run Tests](https://github.com/AlphaNodes/redmine_sudo/workflows/Tests/badge.svg)](https://github.com/AlphaNodes/redmine_sudo/actions?query=workflow%3ATests)
 
-Features
---------
+## Features
 
 * User can switch to admin permission
 * User with admininistrator permission can drop admin permission
 * Multilingual
 
-PROs vs default behavior
-------------------------
+## PROs vs default behavior
 
 __No extra user with admin permissions is required.__
   Common use case is, to create a user called "admin" for it and multiple other users use it.
@@ -24,21 +21,18 @@ __Automatically timeout of working time with admin permission.__
 
 ![Redmine Sudo](./doc/redmine-sudo-usage.gif)
 
-Break Redmine default
----------------------
+## Break Redmine default
 
 If a user has to have admin permisson, he has not this permission after login. He/she must switch to it (with top menu toggle) to get it. Redmine sudo-mode is used for time period and requesting password to switch to admin permission.
 
-Redmine Requirements
---------------------
+## Redmine Requirements
 
 * Redmine version >= 5.0
 * Redmine Plugin: [additionals](https://github.com/alphanodes/additionals)
 * Ruby version >= 3.0
 * **Redmine sudo_mode has to be turned on in config/configuration.yml**
 
-Installation
-------------
+## Installation
 
 Note: all existing admin users will be converted to sudoer (which means, they can switch to admin)
 
@@ -49,13 +43,13 @@ Install ``redmine_sudo`` plugin for `Redmine`
     cd $REDMINE_ROOT
     git clone git://github.com/alphanodes/redmine_sudo.git plugins/redmine_sudo
     git clone git://github.com/alphanodes/additionals.git plugins/additionals
-    bundle install --without development test
+    bundle config set --local without 'development test'
+    bundle install
     bundle exec rake redmine:plugins:migrate RAILS_ENV=production
 
 Restart Redmine (application server) and you should see the plugin show up in the Plugins page.
 
-Uninstall
----------
+## Uninstall
 
 Note: all existing sudoer users will be converted to admin users.
 
@@ -67,12 +61,31 @@ Uninstall ``redmine_sudo``
 
 Restart Redmine (application server)
 
+## Known problems
+
+* for api calls admin permissions are temorarily set for sudoer (not to database). This can be some negative side effect for some return values
+
+## License
+
+This plugin is licensed under the terms of GNU/GPL v2.
+See [LICENSE](LICENSE) for details.
+
+## Redmine Copyright
+
+The redmine_sudo is a plugin extension for Redmine Project Management Software, whose Copyright follows.
+Copyright (C) 2006-  Jean-Philippe Lang
+
+Redmine is a flexible project management web application written using Ruby on Rails framework.
+More details can be found in the doc directory or on the official website <http://www.redmine.org>
+
+This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
 Credits
 -------
 
 * @jbbarth for the idea of this plugin, but a different workflow. You can find his version here: https://github.com/jbbarth/redmine_sudo
-
-Known problems
---------------
-
-* for api calls admin permissions are temorarily set for sudoer (not to database). This can be some negative side effect for some return values