diff --git a/README.md b/README.md index 9ad8463..733002d 100644 --- a/README.md +++ b/README.md @@ -31,12 +31,27 @@ **typescript-monads** helps you write safer code by using abstractions over dubious program state and control flow. -# Installation +# Getting Started +## Node or as a module ```bash npm install typescript-monads ``` +## Browser +```html +
+ + + + +``` + +```js +var someRemoteValue; +typescriptMonads.maybe(someRemoteValue).tapSome(console.log) +``` + # Usage * [Maybe](#maybe) diff --git a/package.json b/package.json index cc2c32a..d4de7cd 100644 --- a/package.json +++ b/package.json @@ -24,7 +24,7 @@ "dist": "ts-node ./scripts/publish-prep.ts", "lint": "tslint --project tsconfig.json --config tslint.json", "build": "tsc -p tsconfig.build.json && npm run rollup && uglifyjs dist/index.js -o dist/index.min.js --source-map", - "rollup": "rollup dist/index.js -o dist/index.js --format umd --name \"typescript-monads\" -m" + "rollup": "rollup dist/index.js -o dist/index.js --format umd --name \"typescriptMonads\" -m" }, "release": { "pkgRoot": "dist"