Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Some tweaks to the README #274

Merged

Conversation

lorcan
Copy link
Contributor

@lorcan lorcan commented Feb 9, 2017

Work in Progress

  • Shortening the table of contents
  • Putting the "defining factories" stuff together, and before the "using factories" stuff
  • Using relative links for the cross-linking (better experience for forks)
  • Moved the changelog to the bottom
  • Moved the "how this works" nearer the top
  • Small tidy-ups and tweaks to the code snippets
  • Misc tweaks to other code.

I feel like this could use more eyes :-)

More context from earlier discussions over at lorcan#1

@danielspaniel
Copy link
Collaborator

I will pull this branch and check it out

@danielspaniel
Copy link
Collaborator

I think it all looks fine Lorcan. I see no problem with merging this when you feel like you are all set.

@lorcan
Copy link
Contributor Author

lorcan commented Feb 10, 2017

👍 if you're happy, I'm happy

@danielspaniel danielspaniel merged commit ef10b44 into adopted-ember-addons:master Feb 10, 2017
@danielspaniel
Copy link
Collaborator

Thanks for making this effort Lorcan. The docs are super important, and it is great that you took the time to make it better.

@lorcan lorcan deleted the lorcan/tweaks-to-readme branch February 11, 2017 15:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants