chore(readme): explain role of ember-could-get-used-to-this better #189
Conversation
- Sections should be complete. If I finish `installation` part of README, I should not need to hunt down for anything that might be missing. - Be explicit: Do X, instead of generic description of what is the idea and leave user wondering. - Explicitly mentioned that it's because of _templates_ code
README.md
Outdated
| @@ -18,6 +18,23 @@ npm install ember-statechart-component | |||
| yarn add ember-statechart-component | |||
| ``` | |||
|
|
|||
| ### Optional | |||
|
|
|||
| To be able to use XState [`state.matches`](https://xstate.js.org/api/classes/state.html#matches) | |||
There was a problem hiding this comment.
I got a little bit tangled in English sentence structure with the "which is available on the state object", so instead I just merged in the information here. It is quite a good term to grep for later on in the README, so it seems ok to me. Happy to change.
|
Take all those as suggestions of a newcomer. Happy to iterate on it. |
- The docs link provide nice example of the syntax - Hints the dot notation
README.md
Outdated
| method in our templates, | ||
| we will first need a `HelperManager` for | ||
| handling vanilla functions. | ||
| [ember-could-get-used-to-this](https://github.com/pzuraq/ember-could-get-used-to-this) |
There was a problem hiding this comment.
I don't think we should mention this addon anymore.
There is: https://github.com/NullVoxPopuli/ember-functions-as-helper-polyfill
And in ember 4.3ish, hopefully it won't even be needed due to implementing this RFC: emberjs/rfcs#756
There was a problem hiding this comment.
Heh, #TIL about ember-function-as-helper-polyfill. I do think however that in some form this needs to stay here, because not everyone's code will be on 4.3+. I will change to use the other addon. Once 4.3(ish) is released, the readme can be changed to give an option to skip this.
README.md
Outdated
|
|
||
| To be able to use XState [`state.matches`](https://xstate.js.org/docs/guides/states.html#state-matches-parentstatevalue) | ||
| method in our templates, | ||
| we will first need a `HelperManager` for |
There was a problem hiding this comment.
Maybe link to helper managers, too?
emberjs/rfcs#625
README.md
Outdated
| @@ -18,6 +18,23 @@ npm install ember-statechart-component | |||
| yarn add ember-statechart-component | |||
| ``` | |||
|
|
|||
| ### Optional | |||
There was a problem hiding this comment.
Why move this under optional?
It'd be reallly awkward to use this library without the rfc 756 behavior
There was a problem hiding this comment.
Fair. I understood that it's only needed for state.matches calls. Which is immensely useful. Just not necessary. But yeh, good defaults.
|
I think I addressed all the comments? |
| @@ -18,6 +18,21 @@ npm install ember-statechart-component | |||
| yarn add ember-statechart-component | |||
| ``` | |||
|
|
|||
| To be able to use XState [`state.matches`](https://xstate.js.org/docs/guides/states.html#state-matches-parentstatevalue) | |||
There was a problem hiding this comment.
thanks for adding this! I like this as part of the installation instructions!
|
looks good! |
|
🎉 This PR is included in version 3.2.2 🎉 The release is available on: Your semantic-release bot 📦🚀 |
installationpart ofREADME, I should not need to hunt down for anything that might
be missing.
idea and leave user wondering.