Rewrite README with code examples #28
Conversation
README.md
Outdated
| @@ -1,21 +1,89 @@ | |||
| # React from Markup | |||
| # react-from-markup | |||
| > Convert static markup into React components, so you can control React props in a static environment. | |||
There was a problem hiding this comment.
I don't think I like this. Would probably prefer to stick with original.
There was a problem hiding this comment.
What if it was simply...
Control your React props with HTML
There was a problem hiding this comment.
Hm, I'm not sure I would understand what that meant. What about mentioning data- attrs.
Control your React props with
data-attributes
Or similar to your original
Declare your React props with
data-attributes
There was a problem hiding this comment.
(oh boy, it's been two months and I still haven't moved on this - really sorry!)
I see/like what you're going for, but it also goes beyond data- props - you can grab a node's textContent, too, or have rehydratable children.
Just spitballing here. Goes further off the rails, and more I'm-pitching-to-a-VC, the further down the list you go.
Set your React props in your HTML
Set your React props from your CMS
Get your props from the markup
Use React with other templating engines
Use React on any website
React, for when React can't be used
And then the pure honesty version:
React, but very slightly worse, but it works everywhere.
README.md
Outdated
| @@ -1,21 +1,89 @@ | |||
| # React from Markup | |||
| # react-from-markup | |||
| > Convert static markup into React components, so you can control React props in a static environment. | |||
There was a problem hiding this comment.
What if it was simply...
Control your React props with HTML
README.md
Outdated
| ``` | ||
|
|
||
| `react-from-markup` is intended to make it possible to use React components on these legacy systems, _without changing the way you write your React components_. It provides tools to simplify the mapping from `data-` attributes into React props, and _can even handle React children_. | ||
| using a `rehydrator`: |
There was a problem hiding this comment.
Pedantic nitpick (sorry in advance!)
rehydrator isn't a piece of code, especially in the new react-from-markup world - it's a term. Could we italicize it instead of codeing it?
README.md
Outdated
| } | ||
| ``` | ||
|
|
||
| This is extremely useful for changing React props in a non-React environment, like a CMS with it’s own templating language. |
| ShowMore: showMoreRehydrator | ||
| }); | ||
| ``` | ||
|
|
There was a problem hiding this comment.
May need a brief note on markup containers here - don't want to overload the "simple get-up-and-running"-ness here, but without a container, react-from-markup doesn't do anything.
|
@simon360 I've addressed all comments in your PR and tweaked it a bit. Please make sure you check over the todo list before merging! |
2 participants
Opening for discussion.
This is just a proposal based on our offline discussions regarding focussing the README on code.
If you decide to move forwards with this / something like this, still need to: