-
Notifications
You must be signed in to change notification settings - Fork 73
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #34 from geekjuice/master
Major updates (UMD, ES6, etc)
- Loading branch information
Showing
18 changed files
with
468 additions
and
2,162 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| ## v1.0.0 | ||
| - Add proper UMD to `Tooltip` | ||
| - Convert from `Coffeescript` to `ES6 (Babel)` | ||
| - Fix `*.json` files to include `main` | ||
| - Remove bundled `tooltip.js` | ||
| - Restructure directory layout | ||
| - Update `gulp` builds | ||
| - Update `drop` dependency to `v1.0.0` | ||
| - Update `tether` dependency to `v0.7.1` | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| # Contributing Guide | ||
|
|
||
| You will need: | ||
|
|
||
| - Node.js/io.js & npm | ||
| - Bower | ||
| - Gulp | ||
| - _Ruby_ (to be deprecated) | ||
| - _Sass gem_ (to be deprecated) | ||
| - _Compass gem_ (to be deprecated) | ||
|
|
||
|
|
||
| ## Getting started | ||
|
|
||
| 1. Fork the project | ||
| 2. Clone your forked project by running `git clone git@github.com:{ | ||
| YOUR_USERNAME }/drop.git` | ||
| 3. Run `npm install` to install both node modules and bower components | ||
| 4. Test that you can build the source by moving/renaming the existing `dist` | ||
| directory and running `npm run build` | ||
| 5. Assuming everything went well, you should now have a `dist` directory that | ||
| matches the one you moved in step 4. | ||
| 6. __NOTE__: Depending on your local version of Sass and Compass, you may end up | ||
| with slightly different stylesheets. In most cases, the changes are | ||
| equivalents and nothing to worry about. That said, we are planning on | ||
| removing the Ruby dependencies to alleviate issues like this. | ||
|
|
||
|
|
||
| ## Writing code! | ||
|
|
||
| We use `gulp` to facilitate things like transpilation, minification, etc. so | ||
| can focus on writing relevant code. If there is a fix or feature you would like | ||
| to contribute, we ask that you take the following steps: | ||
|
|
||
| 1. Most of the _editable_ code lives in the `src` directory while built code | ||
| will end up in the `dist` directory upon running `npm run build`. | ||
| 2. Depending on how big your changes are, bump the version numbers appropriately | ||
| in `bower.json` and `package.json`. We try to follow semver, so a good rule | ||
| of thumb for how to bump the version is: | ||
| - A fix to existing code, perform a patch bump e.g. x.x.0 -> x.x.1 | ||
| - New feature, perform a minor bump e.g. x.0.x -> x.1.x | ||
| - Breaking changes such a rewrite, perform a major bump e.g. | ||
| 1.x.x -> 2.x.x | ||
|
|
||
| Versioning is hard, so just use good judgement and we'll be more than happy | ||
| to help out. | ||
| 3. Provide a thoughtful commit message and push your changes to your fork using | ||
| `git push origin master` (assuming your forked project is using `origin` for | ||
| the remote name and you are on the `master` branch). | ||
| 4. Open a Pull Request on GitHub with a description of your changes. | ||
|
|
||
|
|
||
| ## Testing | ||
|
|
||
| Work in progress. We are hoping to add some tests, so if you would like to help | ||
| us get started, feel free to contact us through the Issues or open a Pull | ||
| Request. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,48 @@ | ||
| ## Tooltip | ||
|
|
||
| ### [Demo](http://github.hubspot.com/tooltip/docs/welcome) [Documentation](http://github.hubspot.com/tooltip) | ||
|
|
||
| Tooltip.js is a Javascript and CSS library for creating styleable tooltips. | ||
| It only depends on [Tether.js](https://github.com/HubSpot/tether). | ||
| It is free and open source and was developed by HubSpot developers Zack Bloom ([@zackbloom](github.com/zackbloom)) and Adam Schwartz ([@adamschwartz](github.com/adamschwartz)). | ||
|
|
||
|
|
||
| ## Install | ||
|
|
||
| __Dependencies__ | ||
|
|
||
| * __[Tether](https://github.com/HubSpot/tether)__ | ||
| * __[Drop](https://github.com/HubSpot/drop)__ | ||
|
|
||
| Installing via `npm` and `bower` will bring in the above dependencies as well. | ||
|
|
||
|
|
||
| __npm__ | ||
| ```sh | ||
| $ npm install tether-tooltip | ||
| ``` | ||
|
|
||
| __bower__ | ||
| ```sh | ||
| $ bower install tether-tooltip | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| ```javascript | ||
| let tooltipInstance = new Tooltip({ | ||
| target: document.querySelector('.tooltip-target'), | ||
| content: "My awesome <b>content</b>.", | ||
| classes: 'tooltip-tether-arrows', | ||
| position: 'top left' | ||
| }) | ||
| ``` | ||
|
|
||
| [API Documentation](http://github.hubspot.com/tooltip) | ||
|
|
||
| [Demo](http://github.hubspot.com/tooltip/docs/welcome) | ||
|
|
||
|
|
||
| ## Contributing | ||
|
|
||
| We encourage contributions of all kinds. If you would like to contribute in some way, please review our [guidelines for contributing](CONTRIBUTING.md). | ||
|
|
||
|
|
||
| ## License | ||
| Copyright © 2015 HubSpot - [MIT License](LICENSE) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.