Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
onokumus committed May 16, 2021
1 parent f75d2f4 commit 0c2fae9
Showing 1 changed file with 29 additions and 33 deletions.
62 changes: 29 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@
* [Author](#author)
* [License](#license)

_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_

## Getting started

Expand All @@ -34,19 +33,19 @@ _(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](
Install with [npm](https://www.npmjs.com/):

```sh
$ npm install --save metismenu
npm install --save metismenu
```

Install with [yarn](https://yarnpkg.com):

```sh
$ yarn add metismenu
yarn add metismenu
```

Install with [composer](https://getcomposer.org/)

```sh
$ composer require onokumus/metismenu:dev-master
composer require onokumus/metismenu:dev-master
```

### Download
Expand Down Expand Up @@ -191,7 +190,7 @@ Default: `a`

```javascript
$("#metismenu").metisMenu({
triggerElement: '.nav-link' // bootstrap 4
triggerElement: '.nav-link' // bootstrap 5
});
```

Expand All @@ -202,7 +201,7 @@ Default: `li`

```javascript
$("#metismenu").metisMenu({
parentTrigger: '.nav-item' // bootstrap 4
parentTrigger: '.nav-item' // bootstrap 5
});
```

Expand All @@ -213,7 +212,7 @@ Default: `ul`

```javascript
$("#metismenu").metisMenu({
subMenu: '.nav.flex-column' // bootstrap 4
subMenu: '.nav.flex-column' // bootstrap 5
});
```

Expand Down Expand Up @@ -246,27 +245,27 @@ Contains a simple HTML file to demonstrate metisMenu plugin.

### Contributors

| **Commits** | **Contributor** |
| --- | --- |
| 212 | [onokumus](https://github.com/onokumus) |
| 8 | [diegozhu](https://github.com/diegozhu) |
| 4 | [sinabs](https://github.com/sinabs) |
| 4 | [DrugoLebowski](https://github.com/DrugoLebowski) |
| 3 | [BurkovBA](https://github.com/BurkovBA) |
| 2 | [arthurtalkgoal](https://github.com/arthurtalkgoal) |
| 2 | [mrdziuban](https://github.com/mrdziuban) |
| 2 | [nicolasigot](https://github.com/nicolasigot) |
| 2 | [PeterDaveHello](https://github.com/PeterDaveHello) |
| 2 | [kalidema](https://github.com/kalidema) |
| 2 | [AndrewEastwood](https://github.com/AndrewEastwood) |
| 2 | [rgnevashev](https://github.com/rgnevashev) |
| 1 | [719media](https://github.com/719media) |
| 1 | [chriswiggins](https://github.com/chriswiggins) |
| 1 | [jmagnusson](https://github.com/jmagnusson) |
| 1 | [LukasDrgon](https://github.com/LukasDrgon) |
| 1 | [Cediddi](https://github.com/Cediddi) |
| 1 | [WoMayr](https://github.com/WoMayr) |
| 1 | [capynet](https://github.com/capynet) |
| **Contributor** |
| --- |
|[onokumus](https://github.com/onokumus) |
| [diegozhu](https://github.com/diegozhu) |
| [sinabs](https://github.com/sinabs) |
|[DrugoLebowski](https://github.com/DrugoLebowski) |
| [BurkovBA](https://github.com/BurkovBA) |
| [arthurtalkgoal](https://github.com/arthurtalkgoal) |
| [mrdziuban](https://github.com/mrdziuban) |
| [nicolasigot](https://github.com/nicolasigot) |
| [PeterDaveHello](https://github.com/PeterDaveHello) |
| [kalidema](https://github.com/kalidema) |
| [AndrewEastwood](https://github.com/AndrewEastwood) |
| [rgnevashev](https://github.com/rgnevashev) |
| [719media](https://github.com/719media) |
| [chriswiggins](https://github.com/chriswiggins) |
| [jmagnusson](https://github.com/jmagnusson) |
| [LukasDrgon](https://github.com/LukasDrgon) |
| [Cediddi](https://github.com/Cediddi) |
| [WoMayr](https://github.com/WoMayr) |
| [capynet](https://github.com/capynet) |

### Contributing

Expand All @@ -278,6 +277,7 @@ Please read the [contributing guide](.github/contributing.md) for advice on open

|**DATE** |**VERSION** |**CHANGES**|
|--------------|--------------|-----------|
|2021-05-16 |v3.0.7 |sass support|
|2020-03-22 |v3.0.6 |fix security vulnerabilities|
|2019-12-28 |v3.0.5 |Fix dispose to be similar to init (adding event) [#184](https://github.com/onokumus/metismenu/pull/184)|
|2019-03-07 |v3.0.4 |fix|
Expand Down Expand Up @@ -328,9 +328,5 @@ Please read the [contributing guide](.github/contributing.md) for advice on open

### License

Copyright © 2020, [Osman Nuri Okumus](https://github.com/onokumus).
Copyright © 2021, [Osman Nuri Okumus](https://github.com/onokumus).
Released under the [MIT License](LICENSE).

***

_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on June 29, 2020._

0 comments on commit 0c2fae9

Please sign in to comment.