modernize our README #2232
modernize our README #2232
Conversation
JoviDeCroock
requested review from
developit,
andrewiggins,
marvinhagemeister,
cristianbote,
ForsakenHarmony and
jviide
In the preact repository we are removing a lot of content from our README, I'm adding it here for visibility (+ linking to here) preactjs/preact#2232
| return ( | ||
| <div> | ||
| <p>Do you agree to the statement: "Preact is awesome"?</p> | ||
| <input value={input} onChange={e => setInput(e.target.value)} /> |
There was a problem hiding this comment.
I worry about using Hooks for the first example, since this sets folks up to end up with stale closures and event handler thrashing without any context. Maybe we should do a side-by-side of hooks and classes to demonstrate?
There was a problem hiding this comment.
Well I think it's pretty linear to just exposing them to doing this in a Component, no? What do you have in mind?
There was a problem hiding this comment.
Since the community is moving toward Hooks right now, I think making the first example Hooks driven gives additional confidence the author written code will not need to be significantly change or refactored.
There was a problem hiding this comment.
+1 For a hooks driven example. My gut tells me that users coming from React will perceive Preact as "old" when the first example only shows classes.
Co-Authored-By: Jason Miller <developit@users.noreply.github.com>
Co-Authored-By: Jason Miller <developit@users.noreply.github.com>
| return ( | ||
| <div> | ||
| <p>Do you agree to the statement: "Preact is awesome"?</p> | ||
| <input value={input} onChange={e => setInput(e.target.value)} /> |
There was a problem hiding this comment.
Since the community is moving toward Hooks right now, I think making the first example Hooks driven gives additional confidence the author written code will not need to be significantly change or refactored.
| @@ -9,7 +9,7 @@ | |||
|
|
|||
There was a problem hiding this comment.
| <p align="center">Fast <b>3kB</b> alternative to React with a similar API.</p> |
There was a problem hiding this comment.
This is for the line above just a proposition
This mainly removes a lot of overhead in favor of our dedicated docs page and preact-awesome list
@developit do you have the link to your gist with the size trial? I'd like to include it here as well to point to if needed
TODO: compare
preact-awesomewith removed links