docs: updating README to the new flame bloc version #1737
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
erickzanardo
requested review from
spydon,
luanpotter,
st-pasha,
renancaraujo and
wolfenrain
|
cc @felangel |
st-pasha
approved these changes
Jun 16, 2022
| @@ -1,6 +1,6 @@ | |||
| MIT License | |||
|
|
|||
| Copyright (c) 2021 Blue Fire | |||
There was a problem hiding this comment.
| @@ -0,0 +1,55 @@ | |||
| # Flame Bloc 🔥🧱 | |||
There was a problem hiding this comment.
Perhaps add a comment here about when this deprecated readme can be removed. This way we make sure the file won't linger forever.
felangel
reviewed
Jun 16, 2022
felangel
reviewed
Jun 16, 2022
| [this](./DEPRECATED_README.md). | ||
|
|
||
| For a migration guide from the previous API to the current one, | ||
| [check this article](https://verygood.ventures/blog/flame-bloc-new-api). |
felangel
reviewed
Jun 16, 2022
felangel
reviewed
Jun 16, 2022
felangel
reviewed
Jun 16, 2022
| updateGear(state); | ||
| } | ||
| } | ||
| ``` |
There was a problem hiding this comment.
Might want to call out one limitation of the mixin is that a component cannot listen to multiple blocs
wolfenrain
approved these changes
Jun 17, 2022
spydon
reviewed
Jun 20, 2022
packages/flame_bloc/README.md
Outdated
|
|
||
| ## ⚠️ IMPORTANT ⚠️ ## | ||
| This README only covers the new (>= 1.4.0) API of flame bloc, for the previous deprecated API check | ||
| [this](./DEPRECATED_README.md). |
There was a problem hiding this comment.
I don't think we need this, if they want to read an old version of the readme they can look at the tag for an old version.
Co-authored-by: Felix Angelov <felangelov@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Updates the README to match the new API.
Checklist
fix:,feat:,docs:etc).docsand added dartdoc comments with///.examples.Breaking Change
Related Issues
Fixes #1695