Update readme #60
Update readme #60
Conversation
pulled out module details into separate files * also began adding examples of module exports updated usage information
|
|
||
| ### Feature Detection | ||
| This package is currently in Alpha with a initial stable release scheduled for later this year. You can install the Alpha | ||
| through npm: |
There was a problem hiding this comment.
The dojo2 package currently available through npm is not this package. Cloning the repo is currently the only way to go.
There was a problem hiding this comment.
I am pretty certain that at least that command does install a compiled version (although, outdated and probably never to be updated) since that alpha version does point to @bryanforbes core repo.
|
Overall the organization is good, but it could be made a bit more consistent. The initial "Installation" and "Dojo Usage" sections should probably be combined, and the usage instructions could be made a bit clearer. |
|
I've updated the branch based on feedback. |
|
Merged via 9becfcf |
|
I'm not sure how heavily this was reviewed before it was merged, but at minimum I would at least suggest changing the headings in the various specific e.g., change: Name - does a thingto NameDoes a thing. (I haven't had time to look in depth as to whether there are any factual issues or omissions in the PR.) |
I have added some information about how to use the modules to the README and moved some of the module descriptions to there only files under the docs/ folder and added some examples to improve ease of use. I tried to also add some of the modules that I felt would be more commonly used as to not have the README get to long.
closes #50