Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

enhance ReadMe #110

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

enhance ReadMe #110

wants to merge 1 commit into from

Conversation

cpprookie
Copy link

linked to #86 #109

Improvement:

  • Create Common patterns section in Readme and introduce track work as decorator or HOC.
  • Lift state-props-usage in Advanced Usage section to Common patterns for users could understand at first glance through example code.

Help want:

My english is really poor as a chinese , so it is much grateful if you could check gramma error.

@tizmagik
Copy link
Collaborator

tizmagik commented Dec 3, 2018

Thank you, this is awesome to see! If you don't mind, I'd rather leave the README as-is and instead create a new CommonPatterns.md doc with these common patterns. The README can link to these Common Patterns instead. I'd like to keep the README focused as documentation for the API and have Common Patterns just act as example code.

@cpprookie
Copy link
Author

@tizmagik Sorry to reply so late.
Of course you can! my last suggestion is that readme needs upgrade. For exmaple, remove es5 example code because es6 is so popular today. If a developer can use decorator, he must understand usage of arrow function. Focus on core things and explain dispatchOnMount process these apis later.
Thanks for your great work. I learned a lot after reading source code. If anything i can help, just tell me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants