Skip to content

Commit

Permalink
Fix docs, readme and package info
Browse files Browse the repository at this point in the history
  • Loading branch information
ulfryk committed Nov 20, 2018
1 parent 2872a2a commit afebfce
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 16 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
### alpha.0

- [new] `.equals()` method added to most entities
- [breaking] all native prototype extentions extracted to `monet-pimp.js`
- [breaking] all native prototype extensions extracted to `monet-pimp.js`
- [enhancement] typings compatible with TS2.x
- [fix] updated module pattern

Expand Down
30 changes: 16 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Monet is a library designed to bring great power to your JavaScript programming.

This library is inspired by those that have come before, especially the [FunctionalJava][functionalJava] and [Scalaz][scalaz] projects.

While functional programming may be alien to you, this library is a simple way to introduce monads and pure functional programming into your daily practises.
While functional programming may be alien to you, this library is a simple way to introduce monads and pure functional programming into your daily practices.

## Documentation

Expand All @@ -20,23 +20,25 @@ Full detailed documentation can be found [here](docs/README.md)

Download the [zip][gitZip] or [tar][gitTar] ball.

## Installation
### installation

Simply download and add to your html pages or we also support [npm]. You can also include `monet-pimp.js` which contains extra functions on the `Object.prototype` for creating monads.

```html
<script type="text/javascript" src="monet.js"></script>
<!-- Optionally -=>
<script type="text/javascript" src="monet-pimp.js"></script>
```
### NPM installation
#### NPM

```bash
npm install monet --save

# or to install a specific version
npm install monet@0.9.0-rc.0
npm install monet@0.9.0
```

#### Browser

Simply download and add to your html pages or we also support [npm]. You can also include `monet-pimp.js` which contains extra functions on the `Object.prototype` for creating monads.

```html
<script type="text/javascript" src="monet.js"></script>
<!-- Optionally -->
<script type="text/javascript" src="monet-pimp.js"></script>
```

## Contents
Expand Down Expand Up @@ -86,7 +88,7 @@ Please see [Ken Scambler](http://twitter.com/KenScambler)'s [excellent talk](htt
Written and maintained by Chris Myers [@cwmyers](https://twitter.com/cwmyers) and Jakub Strojewski [@ulfryk](https://twitter.com/ulfryk). Follow Monet.js at [@monetjs](http://twitter.com/monetjs).

[functionalJava]: http://functionaljava.org/
[gitZip]: https://github.com/monet/monet.js/archive/v0.8.10.zip
[gitTar]: https://github.com/monet/monet.js/archive/v0.8.10.tar.gz
[gitZip]: https://github.com/monet/monet.js/archive/v0.9.0.zip
[gitTar]: https://github.com/monet/monet.js/archive/v0.9.0.tar.gz
[npm]: https://www.npmjs.com/
[scalaz]: https://github.com/scalaz/scalaz
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"author": "Chris Myers",
"contributors": [
"Jakub Strojewski <jakub.strojewski@gmail.com>",
"Jakub Strojewski <ulfryk@gmail.com>",
"emmanueltouzery",
"tomecko",
"WojciechP"
Expand Down

0 comments on commit afebfce

Please sign in to comment.