Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
alexandermeindl committed Oct 5, 2024
1 parent a94f54d commit 54f0312
Showing 1 changed file with 24 additions and 14 deletions.
38 changes: 24 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,21 @@
Collapsible Stateful Sidebar
============================
# Collapsible Stateful Sidebar

[![Run RuboCop](https://github.com/AlphaNodes/redmine_collapsible_sidebar/workflows/Run%20Linters/badge.svg)](https://github.com/AlphaNodes/redmine_collapsible_sidebar/actions/workflows/linters.yml)

Features
--------
## Features

- collapsable sidebar
- Using local storage to remember status of the sidebar for each page

Solution is based on <https://www.redmine.org/issues/21808#note-27>. If this is part of Redmine, this plugin will be deprecated.

Requirements
------------
## Requirements

- Redmine version >= 5.0
- Redmine Plugin: [additionals](https://github.com/alphanodes/additionals) - used for FontAwesome support
- Ruby version >= 2.7
- Ruby version >= 3.0

Installation
------------
## Installation

```shell
cd $REDMINE_ROOT
Expand All @@ -31,8 +27,7 @@ bundle install

Restart your application server after installation.

Uninstall
---------
## Uninstall

Uninstall `redmine_collapsible_sidebar` plugin.

Expand All @@ -43,7 +38,22 @@ rm -rf plugins/redmine_collapsible_sidebar public/plugin_assets/redmine_collapsi

Restart Redmine (application server)

License
-------
## License

SEE [LICENSE](LICENSE)
This plugin is licensed under the terms of GNU/GPL v2.
See [LICENSE](LICENSE) for details.

## Redmine Copyright

The redmine_collapsible_sidebar 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.

0 comments on commit 54f0312

Please sign in to comment.