Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
icoach committed Feb 2, 2017
1 parent fc20c8d commit 14dceee
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,31 @@
# [Priority navigation plugin](http://skywalkapps.github.io/nav-priority)
# [Priority Navigation](http://skywalkapps.github.io/nav-priority)
![Bower version](https://img.shields.io/bower/v/bootstrap.svg?style=flat)
[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](LICENSE)

To get started, check out <http://skywalkapps.github.io/nav-priority>!

## Quick start

Priority navigation plugin is written in vanilla JS, so it can be easily integrated to your existing codebase. It is also fully compatible with Bootstrap 3. You have following options of installation:
Priority Navigation is an implementation of priority+ pattern. This plugin is written in vanilla JS, so it can be easily integrated to your existing codebase without other dependencies. It is fully compatible with Bootstrap 3. You have following options of installation:

- [Download the latest release](https://github.com/skywalkapps/nav-priority/archive/v1.0.0.zip).
- Clone the repo: `git clone https://github.com/skywalkapps/nav-priority.git`.
- Install with [Bower](http://bower.io): `bower install nav-priority`.

### How to use

The plugin requires only one file to include in your project. Within the download you'll find minified and plain versions of JS.
Include JS and CSS for the plugin in your project. Choose between uncompressed and minified files.

```
nav-priority/
└── dist/
├── nav-priority.js
└── nav-priority.min.css
└── javascripts/
├── nav-priority-util.js
├── nav-priority.js
└── nav-priority.min.js
└── stylesheets
├── nav-priority.css
└── nav-priority.min.css
```

## Creator
Expand All @@ -32,4 +37,4 @@ nav-priority/

## Copyright and license

Code and documentation copyright 2015 Martin Staněk. Code released under [the MIT license](https://github.com/skywalkapps/bootstrap-dropmenu/blob/master/LICENSE).
Code and documentation copyright 2017 Martin Staněk. Code released under [the MIT license](https://github.com/skywalkapps/nav-priority/blob/master/LICENSE).

0 comments on commit 14dceee

Please sign in to comment.