Document angle-bracket and Ember bug

Glavin001 · Jul 28, 2019 · 6879294 · 6879294
1 parent 613ad08
commit 6879294
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Change Log
 
+## v2.0.1 (July 28, 2019)
+
+* README - added example using angle bracket invocation
+* README - documented Ember bug re: angle bracket invocation doesn't work on components with numbers in their name.  Bug was fixed in Ember 3.8
+
 ## v2.0.0 (July 10, 2019)
 
 * Bumped c3/d3 and other dependencies 

diff --git a/README.md b/README.md
@@ -48,6 +48,15 @@ Where `model` is your C3 data:
 {{c3-chart data=model}}
 ```
 
+Using angle bracket invocation (see note below):
+
+```handlebars
+<C3Chart @data={{model}} />
+```
+
+> Note: Angle brackets were available in Ember 3.4. An Ember bug prevented use of numbers in component names so <C3Chart /> will generate an error. The bug was fixed with PR [#17552](https://github.com/emberjs/ember.js/pull/17552) which was merged into Ember 3.8. Ember-C3 can use angle brackets only with ember source 3.8 and later 
+
+
 ### Advanced
 
 See http://c3js.org/examples.html for examples of how to use C3.