readme and doc consolidation updates #408
Merged
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
|
Thank you so much Gregg. This is going to have a huge impact on our adoption. |
|
I have some more WIP for another PR, but I think this is a good update on its own. |
|
Mind giving it a look @tkh44 ? |
greggb
changed the title
mrmartineau
reviewed
Oct 15, 2017
| @@ -0,0 +1,36 @@ | |||
| ## Usage with Babel | |||
There was a problem hiding this comment.
Absolutely - I'm not sure of all the options
mrmartineau
reviewed
Oct 15, 2017
| ### Features which are enabled with the babel plugin | ||
|
|
||
| ### styled.element Syntax | ||
| `styled('div')` will work without the plugin |
There was a problem hiding this comment.
I'd like to see an explanation of the two syntax types and the reason for using one over the other. It probably should go in the 'getting started' section (if there is one..) though
There was a problem hiding this comment.
I have a getting started doc on deck for my next PR. I'll need some help understanding the big differences between syntaxes
|
I will look at this when I get some time today |
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.
What: Added some quick start info on main readme and consolidated some documentation.
Why: The docs need updating
Still a work in progress.
Todo: