From 1fa475319ad4c24148c19dcb8faa149d30236c85 Mon Sep 17 00:00:00 2001 From: Jiansen Date: Sun, 3 Jul 2016 13:32:04 +0100 Subject: [PATCH] feat(README): update READ me so that users are aware of the CoffeeScript usage example --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4d8605f..2603bac 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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