Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
onokumus committed Mar 10, 2014
1 parent 197a8c6 commit 7ec81f9
Show file tree
Hide file tree
Showing 4 changed files with 107 additions and 3 deletions.
3 changes: 3 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
language: node_js
node_js:
- 0.10
48 changes: 45 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,46 @@
metisMenu
=========
# metisMenu [![Build Status](https://secure.travis-ci.org/onokumus/metisMenu.png?branch=master)](https://travis-ci.org/onokumus/metisMenu)

Easy menu jQuery plugin for Twitter Bootstrap 3
> Easy menu jQuery plugin for Twitter Bootstrap 3
## Usage

1. Include jQuery

```html
<script src="http://ajax.googleapis.com/ajax/libs/jquery/2.1.0/jquery.min.js"></script>
```

2. Include Twitter Bootstrap

```html
<script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
```

3. Include metisMenu plugin's code

```html
<script src="jquery.metisMenu.js"></script>
```

4. Call the plugin:

```javascript
$("#menu").metisMenu();
```

#### [demo](http://onokumus.github.io/metisMenu/)

Contains a simple HTML file to demonstrate metisMenu plugin.

## Author

metisMenu was made with love by these guys and a bunch of awesome [contributors](https://github.com/onokumus/metisMenu/graphs/contributors).

[![Osman Nuri Okumuş](https://0.gravatar.com/avatar/4fa374411129d6f574c33e4753ec402e?s=70)](http://onokumus.com) |
--- | --- | --- | --- | --- | --- | ---
[Osman Nuri Okumuş](http://onokumus.com) |


## License

[MIT License](https://github.com/onokumus/metisMenu/blob/master/LICENSE)
29 changes: 29 additions & 0 deletions bower.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"name": "metisMenu",
"version": "1.0.0",
"homepage": "https://github.com/onokumus/metisMenu",
"authors": [
"onokumus <[email protected]>"
],
"description": "Easy menu jQuery plugin for Twitter Bootstrap 3",
"main": "jquery.metisMenu.js",
"keywords": [
"twitter",
"bootstrap",
"twbs",
"jquery",
"menu",
"accordion",
"toggle",
"metis",
"metisMenu"
],
"license": "MIT",
"ignore": [
"**/.*",
"node_modules",
"bower_components",
"test",
"tests"
]
}
30 changes: 30 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{
"name": "metismenu",
"version": "1.0.0",
"description": "Easy menu jQuery plugin for Twitter Bootstrap 3",
"main": "jquery.metisMenu.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
"type": "git",
"url": "https://github.com/onokumus/metisMenu.git"
},
"keywords": [
"twitter",
"bootstrap",
"twbs",
"jquery",
"menu",
"accordion",
"toggle",
"metis",
"metisMenu"
],
"author": "Osman Nuri Okumuş <[email protected]> (http://onokumus.com/)",
"license": "MIT",
"bugs": {
"url": "https://github.com/onokumus/metisMenu/issues"
},
"homepage": "https://github.com/onokumus/metisMenu"
}

0 comments on commit 7ec81f9

Please sign in to comment.