Merge pull request #48 from graviton/47-prepare-incubator

chore(project): README and package.json

LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2016 Zalando SE
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,11 +1,12 @@
 # lib-oauth-tooling
 
-A simple typescript based OAuth support library supporting OAuth2 flow, currently it supports:
+A simple typescript based library for supporting OAuth2 flows.
+Currently the following flows are supported:
 
-* Authorization Code flow
-* Resource Owner Password Credentials Grant
+* [Authorization Code Flow](https://tools.ietf.org/html/rfc6749#section-1.3.1)
+* [Resource Owner Password Credentials Grant](https://tools.ietf.org/html/rfc6749#section-1.3.3)
 * Express middlewares to simplify authentication/authorization
-* `TokenCache` service to manage your access tokens in your node application
+* `TokenCache` service to manage access tokens in your application
 
 See [STUPS documentation](http://stups.readthedocs.org/en/latest/user-guide/access-control.html#implementing-a-client-asking-resource-owners-for-permission) and [OAuth2 documentation](https://tools.ietf.org/html/rfc6749) for more information.
 
@@ -14,7 +15,7 @@ See [STUPS documentation](http://stups.readthedocs.org/en/latest/user-guide/acce
 
 Note: `node >= 6.0.0` required to consume this library.
 
-Run `npm install --save git+ssh://git@github.bus.zalan.do:graviton/lib-oauth-tooling.git#TAG/COMMIT` where `TAG/COMMIT` has to be replaced with the release tag or commit id you want to use.
+Run `npm install --save git+https://github.com/zalando-incubator/lib-oauth-tooling.git#<commit-ish>` where `<commit-ish>` has to be replaced with the release tag or commit id you want to use.
 Import a member of this lib like so (of course ES5 syntax is working as well...):
 
 ```typescript
@@ -201,11 +202,6 @@ Both commands require a global installed mocha (`npm install -g mocha`) and ts-n
 * `npm run integration-test` - runs integration tests
 
 
-## Create a new version
+## License
 
-* [ ] `tsc` - compile
-* [ ] run the following npm scripts (`npm run <scriptName>`) to lint and test: `tslint`, `test`, `integration-test`
-* [ ] if no errors occur, increase version in `package.json`
-* [ ] `git commit -m "increase version"`
-* [ ] `git tag -a x.y.z -m "Message(optional) Tagged x.y.z"` (use [semantic versioning](http://semver.org/))
-* [ ] `git push origin `
+MIT

package.json

@@ -1,11 +1,15 @@
 {
   "name": "lib-oauth-tooling",
-  "version": "0.18.1",
-  "description": "A simple typescript based oauth tooling library.",
+  "version": "0.18.2",
+  "description": "A simple typescript based oauth tooling library",
   "main": "./lib/src/index.js",
   "typings": "./lib/src/index.d.ts",
-  "private": true,
-  "license": "UNLICENSED",
+  "license": "MIT",
+  "keywords": [
+    "zalando",
+    "oauth2",
+    "typescript"
+  ],
   "directories": {
     "test": "test",
     "lib": "lib"
@@ -35,7 +39,15 @@
     "integration-test": "mocha --opts integration-test/mocha.opts --harmony_default_parameters",
     "tslint": "tslint src/**/*.ts test/**/*.ts integration-test/**/*.ts"
   },
-  "author": "Graviton <[email protected]>",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/zalando-incubator/lib-oauth-tooling.git"
+  },
+  "maintainers": [
+    "Jörg Dotzki <[email protected]>",
+    "Alexander Dellagi <[email protected]>",
+    "Bastian Sieker <[email protected]>"
+  ],
   "contributors": [
     {
       "name": "Jörg Dotzki",