Skip to content

Commit

Permalink
feat(README): update READ me so that users are aware of the CoffeeScr…
Browse files Browse the repository at this point in the history
…ipt usage example
  • Loading branch information
Jiansen committed Jul 3, 2016
1 parent e9b485d commit 1fa4753
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,16 @@


# match-js
Patten matching via extractor objects in JavaScript
Patten matching via extractor objects in JavaScript.

This library is currently developed in ES6 and then transforms to ES5 using [Babel](https://babeljs.io/). The library is tested against examples written in ES6 ES5 and CoffeeScript.

## Documents & Notes

TODO: documents will be in the [docs](./docs) folder.

### Plan
- To simplify the syntax/APIs, in ES6, ES5, and some JavaScript derived languages. If you would like to use match-js in you favourite language, please open an [issue](https://github.com/Jiansen/match-js/issues).
- To simplify the syntax/APIs, in ES6, ES5, CoffeeScript, and some other JavaScript derived languages. If you would like to use match-js in you favourite language, please open an [issue](https://github.com/Jiansen/match-js/issues).
- To support more types of patterns and usage cases. To request a feature, open an [issue](https://github.com/Jiansen/match-js/issues) and give a snippet of the code in your mind. As library designers, we'd like to see how you wanted to write code. The code snippet does not have to be executable (for now).
- To refactor some small to medium sized libraries/applications using match-js, see if this library may contribute to better code. If you have an candidate library/application in mind, please give it a go, and create a pull request to add your examples in the [Standalone Examples](#standalone-examples) Section.

Expand Down Expand Up @@ -99,6 +101,7 @@ ES6 source files
* `npm run dev` - produces development version of your library and runs a watcher
* `npm run test:es5` - runs the tests written in ES5 (*.spec.est5:js)
* `npm run test:es6` - runs the tests written in ES6 (*.spec.es6.js)
* `npm run test:coffee` - runs the tests written in CoffeeScript (*.spec.coffee)


## Release with semantic-release
Expand Down

0 comments on commit 1fa4753

Please sign in to comment.