Merge pull request #87 from HubSpot/version-1

Major upgrade to version 1

Author: geekjuice

CHANGELOG.md

@@ -0,0 +1,6 @@
+## v1.0.0
+- Coffeescript -> ES6
+- Proper UMD Wrapper
+- Update build steps
+- Add changelog
+- Provide minified CSS

CONTRIBUTING.md

@@ -0,0 +1,59 @@
+# Contributing Guide
+
+You will need:
+
+- Node.js/io.js & npm
+- Bower
+- Gulp
+
+
+## Getting started
+
+1. Fork the project
+2. Clone your forked project by running `git clone [email protected]:{
+   YOUR_USERNAME }/tether.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
+
+
+## Writing code!
+
+We use `gulp` to facilitate things like transpilation, minification, etc. so
+can you 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.
+
+   __NOTE__: There is a `gulp` task that will automate some of the versioning.
+   You can run `gulp version:{type}` where type is `patch|minor|major` to
+   update both `bower.json` and `package.json` as well as add the appropriate
+   git tag.
+
+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.
+

README.md

@@ -6,6 +6,29 @@ It aims to be the canonical implementation of this type of positioning, such tha
 
 Take a look at the documentation for a more detailed explanation of why you should star it now to remember it for your next project.
 
+## Install
+
+__npm__
+```sh
+$ npm install tether
+```
+
+__bower__
+```sh
+$ bower install tether
+```
+
+## Usage
+
 [![Tether Docs](http://i.imgur.com/YCx8cLr.png)](http://github.hubspot.com/tether/#usage)
 
-### [Demo & Documentation](http://github.hubspot.com/tether/)
+[Demo & API Documentation](http://github.hubspot.com/tether/)
+
+
+## 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)

bower.json

@@ -1,17 +1,20 @@
 {
   "name": "tether",
-  "version": "0.7.2",
-  "main": "tether.js",
+  "version": "1.0.0",
   "homepage": "https://github.hubspot.com/tether",
   "authors": [
     "Zack Bloom <[email protected]>",
     "Adam Schwartz <[email protected]>"
   ],
+  "maintainers": [
+    "Nicholas Hwang <[email protected]>"
+  ],
   "description": "A client-side library to make absolutely positioned elements attach to elements in the page efficiently.",
   "keywords": [
     "javascript"
   ],
   "license": "MIT",
+  "main": "dist/js/tether.js",
   "ignore": [
     "**/.*",
     "node_modules",