Skip to content

Commit a9a5c6a

Browse files
committed
update README
1 parent 4cb2e88 commit a9a5c6a

File tree

1 file changed

+24
-12
lines changed

1 file changed

+24
-12
lines changed

README.md

Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,22 @@
1111
The mobile first menu navigation for today's modern web, sourced with Typescript and packed with lots of features.
1212

1313

14-
# Demo
14+
## Demo
1515
Download the package and check the **docs** folder, or check it online [here](http://thednp.github.io/navbar).
1616

1717
# Navbar Highlights
1818
* Mobile First Design
1919
* Accessibility Focus
2020
* TypeScript sourced and powerful build tools
21-
* SCSS sources with powerful mixins and CSS variables
21+
* SCSS sources with flexible mixins and CSS variables
2222
* very light footprint, `5kb` in size when minified
2323
* 3 sets of positions top (main), left or right
2424
* provides a set of options for JavaScript initialization
2525
* DATA API allows you to automatically initiate without JS invocation
26-
* modern browsers supported and semi-modern alike with a special polyfill for IE10+ provided
26+
* modern browsers supported
2727

28-
# How It Works
28+
29+
## How It Works
2930
**On mobile**
3031
* uses the native events behavior, it requires some elements to click on
3132
* shows the `<button class="navbar-toggle">` element for element visibility toggle
@@ -39,14 +40,25 @@ Download the package and check the **docs** folder, or check it online [here](ht
3940

4041
On both mobile and desktop, Navbar.js allows for full keyboard navigation via the **TAB** and **SPACE** keys. In addition, directional arrows provide navigation on desktop with RTL support.
4142

42-
# NPM
43-
You can install this through NPM:
43+
## Install
44+
```bash
45+
pnpm install -D @thednp/navbar
46+
```
47+
48+
```bash
49+
yarn add -D @thednp/navbar
50+
```
4451

52+
```bash
53+
npm install -D @thednp/navbar
4554
```
46-
$ npm install @thednp/navbar
55+
56+
```bash
57+
deno add -D npm:@thednp/navbar@latest
4758
```
4859

49-
# Browser Usage
60+
61+
## Browser Usage
5062
Download the [latest package](https://github.com/thednp/navbar/archive/master.zip). unpack and inspect the contents. You need to copy the `navbar.js` and `navbar.css` or their minified variations to your app `assets` folders as follows.
5163
Link the required CSS in your document `<head>` tag
5264
```html
@@ -95,13 +107,13 @@ Alternatively you can use only the menu itself and use the specific attribute:
95107
Other initialization and markup options apply, explained in [the demo](http://thednp.github.io/navbar/).
96108

97109

98-
# Typescript / ES
99-
```javascript
110+
## Typescript / ES
111+
```ts
100112
import Navbar from '@thednp/navbar'
101113

102114
const myNav = new Navbar('#myNav')
103115
```
104116

105117

106-
# License
107-
[MIT License](https://github.com/thednp/navbar/blob/master/LICENSE)
118+
## License
119+
Navbar is released under [MIT License](https://github.com/thednp/navbar/blob/master/LICENSE).

0 commit comments

Comments
 (0)