Restructure readme to help new users get started #106
Merged
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.
Combines the "Installation" and "Usage" sections (now after the demo / example etc) to help new users get started with minimal frustration. Fixes #105.
Background
I recently discovered this wonderful addon, but thought that it wasn't working in my Ember app for some reason... until I scrolled past the examples in the readme and spotted the "Usage" section - which told me how to finish setting it up.
Alternatives
I've put the newly-combined "Installation & Usage" section after the examples, demo and "Why use it?" sections - but it could just as well come before them (as the "Installation" section did before).