Permalink
Browse files

Merge pull request #24 from repoify/add/repository

Add repository field to readme
  • Loading branch information...
2 parents a24730e + b37abcf commit e21d052da10fa721d4ebad613d804b1ddccdb228 @jonathanong jonathanong committed Oct 9, 2013
Showing with 5 additions and 1 deletion.
  1. +5 −1 package.json
View
6 package.json
@@ -22,5 +22,9 @@
},
"readme": "# Dropdown\n\n Dropdown component with structural styling.\n\n ![js dropdown\n component](http://f.cl.ly/items/010I1g3E2I3j2j2E3j0F/Screen%20Shot%202012-08-10%20at%2011.40.20%20AM.png)\n\n## Installation\n\n```\n$ npm install dropdown-component\n```\n\n## Features\n\n It inherits all properties of [Menu component](http://www.github/component/menu)\n\n - events for composition\n - structural CSS letting you decide on style\n - fluent API\n - arrow key navigation\n\n## Events\n\n It inherits all events of [Menu component](http://www.github/component/menu). It\n not added anymore.\n\n## Dependencies\n\n * menu-component\n\n## Example\n\n```js\nvar Dropdown = require('dropdown');\n\nvar dropdown = new Dropdown('.fruits-dropdown');\n\ndropdown\n.add('Banana')\n.add('Apple', function(){ console.log('Apple selected'); })\n.add('Lemon', function(){ console.log('Lemon'); })\n.add('Remove \"Apple\"', function(){\n dropdown.remove('Lemon');\n})\n.focus('Apple');\n\n```\n\n## API\n \n### Dropdown(ref, options)\n\n Create a new `Dropdown` associated to `ref` element. Also support the follow\n options:\n\n - menu: {Boolean} value that defines if dropdown support menu behaviur.\n - items: {Array} of initial items.\n - select: {String} defines the focused item\n\n```js\nvar Dropdown = require('dropdown');\nvar dropdown = Dropdown('.dropdown-link', {\n menu: true\n , items: [\n ['apple', '<em>Apple</em>', funcrion (){ console.log('It\\'s an Apple!') }]\n , ['orange', '<strong style=\"color: #f86\">orange</strong>']\n , ['banana', '<strong>Banana</strong>']\n , ['strawberry', function() {\n console.log('remove the orange');\n dropdown.remove('orange');\n }\n ]\n ]\n , select: 'banana'\n});\n```\n\n### Inherits methods:\n\n### Dropdown#add([slug], text, [fn])\n### Dropdown#remove(slug)\n### Dropdown#has(slug)\n### Dropdown#show()\n### Dropdown#hide()\n\n### Dropdown#focus(slug):\n\n Focus dropdown with the item given.\n\n```js\n dropdown.focus('banana');\n```\n\n## License\n\n (The MIT License)\n Copyright(c) 2012 Damian Suarez <rdsuarez@gmail.com>\n \n Permission is hereby granted, free of charge, to any person obtaining\n a copy of this software and associated documentation files (the\n 'Software'), to deal in the Software without restriction, including\n without limitation the rights to use, copy, modify, merge, publish,\n distribute, sublicense, and/or sell copies of the Software, and to\n permit persons to whom the Software is furnished to do so, subject to\n the following conditions:\n \n The above copyright notice and this permission notice shall be\n included in all copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,\n EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\n MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\n IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\n CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\n TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\n SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n",
"_id": "dropdown-component@0.1.0",
- "_from": "dropdown-component@0.1.0"
+ "_from": "dropdown-component@0.1.0",
+ "repository": {
+ "type": "git",
+ "url": "https://github.com/component/dropdown.git"
+ }
}

0 comments on commit e21d052

Please sign in to comment.