Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<head>
<script src="https://unpkg.com/typescript-monads"></script>
<!-- or use a specific version to avoid a redirect -->
<script src="https://unpkg.com/typescript-monads@3.5.3/index.js"></script>
</head>
```

```js
var someRemoteValue;
typescriptMonads.maybe(someRemoteValue).tapSome(console.log)
```

# Usage

* [Maybe](#maybe)
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down