Add note to point devs at @most/core for new projects #526
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
davidchase
approved these changes
Aug 22, 2018
Frikki
requested changes
Aug 23, 2018
README.md
Outdated
| @@ -13,6 +13,16 @@ _ / / / / /_/ /____/ /_ / | |||
| [](https://travis-ci.org/cujojs/most) | |||
| [](https://gitter.im/cujojs/most?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) | |||
|
|
|||
| ## Starting a new project? | |||
|
|
|||
| Strongly consider starting with [`@most/core`](https://github.com/mostjs/core). It is the foundation of the upcoming most 2.0, has [improved documentation](http://mostcore.rtfd.io/), new features, better tree-shaking build characteristics, and simpler APIs. Updating from `@most/core` to most 2.0 will be simple and non-breaking. | |||
There was a problem hiding this comment.
Update to avoid over-used words, such as “simple”:
Strongly consider starting with @most/core. It is the foundation of the upcoming most 2.0, has improved documentation, new features, better tree-shaking build characteristics, and simpler APIs. Updating from @most/core to most 2.0 will be non-breaking and straightforward.
|
I added the same note to the top of the API docs in 4934638 |
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.
Summary
@most/coreis the future of mostjs, and most 2.0 is close. Most 2.0 will be based on@most/core, will be directly compatible with it, and will be a trivial upgrade for folks who prefer a single dependency in their package.json.The goal of this addition is to help devs make a more forward-compatible choice for new projects and let them know there will be a guide to help them upgrade existing projects. It encourages devs to pick
@most/corenow for new projects, and points existing most 1.x-based projects to the upgrade guide (still a WIP as of this writing).