Skip to content

Commit

Permalink
✏️ Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Molkobain committed Oct 24, 2021
1 parent a96cd2d commit fe23118
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

## [Unreleased]

## [1.4.0] - 2021-10-20
### Added
- Add config. param. to enable/disable the extension

## [1.3.0] - 2021-04-04
### Changed
- Upgrade to FontAwesome v5.15.3
Expand Down
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,15 @@ Downloading it directly from the *Clone or download* will get you the version un
## Configuration
No configuration needed.

### Parameters
Some configuration parameters are available from the Configuration editor of the console:
* `enabled` Enable / disable the extension without having to uninstall it. Value can be `true` or `false`.

*Default values:*
```
'enabled' => true,
```

## How to
### Portal: Change a brick's icon
Let's say that for example you would like to change the *New request* icon with [this one](https://fontawesome.com/icons/book-open?style=solid). Just alter the portal XML to change the ``/itop_design/module_designs/module_design[@id="<PORTAL_ID>"]/bricks/brick[@id="services"]/decoration_class/default`` tag value with *fas fa-book-open fa-2x*
Expand Down

0 comments on commit fe23118

Please sign in to comment.