Skip to content

Commit 89c28f1

Browse files
author
Nick Hwang
committed
Update readme and *.json
1 parent 6e5dcfb commit 89c28f1

File tree

3 files changed

+48
-2
lines changed

3 files changed

+48
-2
lines changed

README.md

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,47 @@ Drop.js is a powerful Javascript and CSS library for creating dropdowns and othe
44

55
[![Drop Docs](http://i.imgur.com/sgmx9aJ.png)](http://github.hubspot.com/drop/)
66

7-
### [Demo](http://github.hubspot.com/drop/docs/welcome)    [Documentation](http://github.hubspot.com/drop)
7+
8+
## Install
9+
10+
__Dependencies__
11+
12+
* __[Tether](https://github.com/HubSpot/tether)__
13+
14+
Installing via `npm` and `bower` will bring in the above dependencies as well.
15+
16+
17+
__npm__
18+
```sh
19+
$ npm install tether-drop
20+
```
21+
22+
__bower__
23+
```sh
24+
$ bower install tether-drop
25+
```
26+
27+
## Usage
28+
29+
```javascript
30+
let dropInstance = new Drop({
31+
target: document.querySelector('.drop-target'),
32+
content: 'Welcome to the future',
33+
classes: 'drop-theme-arrows',
34+
position: 'bottom left',
35+
openOn: 'click'
36+
})
37+
```
38+
39+
[API documentation](http://github.hubspot.com/drop)
40+
41+
[Demo](http://github.hubspot.com/drop/docs/welcome)
42+
43+
44+
## Contributing
45+
46+
We encourage contributions of all kinds. If you would like to contribute in some way, please review our [guidelines for contributing](CONTRIBUTING.md).
47+
48+
49+
## License
50+
Copyright © 2015 HubSpot - [MIT License](LICENSE)

bower.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "drop",
2+
"name": "tether-drop",
33
"version": "1.0.0",
44
"homepage": "https://github.com/HubSpot/drop",
55
"authors": [

package.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,8 @@
2424
"gulp-ruby-sass": "^1.0.5",
2525
"gulp-uglify": "^1.2.0",
2626
"gulp-wrap-umd": "^0.2.1"
27+
},
28+
"dependencies": {
29+
"tether": "^0.7.1"
2730
}
2831
}

0 commit comments

Comments
 (0)