nytimes / react-tracking

🎯 Declarative tracking for React apps.
https://open.nytimes.com/introducing-react-tracking-declarative-tracking-for-react-apps-2c76706bb79a
Other
1.88k stars 123 forks source link

enhance ReadMe #110

Open cpprookie opened 5 years ago

cpprookie commented 5 years ago

linked to #86 #109

Improvement:

Help want:

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

tizmagik commented 5 years ago

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 commented 5 years ago

@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.