update readme with js & babel 7 usage (#73)

mgechev · Nov 15, 2018 · a58040b · a58040b
1 parent 79c21d1
commit a58040b
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -2,8 +2,14 @@
 
 [![Build Status](https://travis-ci.org/mgechev/aspect.js.svg?branch=master)](https://travis-ci.org/mgechev/aspect.js)
 
+
 Library for aspect-oriented programming with JavaScript, which takes advantage of ECMAScript 2016 decorators syntax.
 
+> NOTE: if you are using `aspect.js` in a plain JavaScript project that uses [`@babel/plugin-proposal-decorators`](https://www.npmjs.com/package/@babel/plugin-proposal-decorators), you _must_ set its `legacy` property to `true` until [#72](https://github.com/mgechev/aspect.js/issues/72) is fixed.
+See [this migration note](https://babeljs.io/docs/en/v7-migration#babel-plugin-proposal-decorators) for more information.
+A sample project using JavaScript with Node >=10.12.0 (or >=8.12.0) & Babel 7.x can be found at https://github.com/matthewadams/aspect.js-babel7-poc.
+It's a good way to get going quickly with `aspect.js` in that environment.
+
 For further reading on decorators, take a look at [the spec](https://github.com/wycats/javascript-decorators).
 
 Blog post, introduction to the AOP and the library could be found [here](http://blog.mgechev.com/2015/07/29/aspect-oriented-programming-javascript-aop-js).