This repository has been archived by the owner on Feb 6, 2023. It is now read-only.
Add 'Getting Started' section to README
#865
Assignees
Comments
flarnie
pushed a commit
that referenced
this issue
Dec 15, 2016
* Update Readme.md Updated Readme.md to include a Getting Started section using information from the documentation. * Update Readme.md Adjusted some headings to be H3 to appear as sub-headings in the Getting Started section to provide better reading flow.
|
closed by #872 |
ouchxp
pushed a commit
to ouchxp/draft-js
that referenced
this issue
Apr 7, 2017
…acebookarchive#872) * Update Readme.md Updated Readme.md to include a Getting Started section using information from the documentation. * Update Readme.md Adjusted some headings to be H3 to appear as sub-headings in the Getting Started section to provide better reading flow.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Context:
If someone starts by looking at the
READMEthe first entrypoint they are given is to download master and try the examples.Honestly this might be confusing, because master is in a state where we are updating and improving APIs. It does not match the current documentation for v0.9.1. See #839
Let's try adding a 'Getting Started' section, similar to the Immutable.js 'Getting Started'.
We could even just copy the content from the main Draft docs about installation and usage: https://facebook.github.io/draft-js/docs/overview.html#installation
Also, if you (hello there!) have ideas about how to make things more clear to brand new users, we welcome your ideas.
The text was updated successfully, but these errors were encountered: