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

Better README #35

Open
osxi opened this issue Sep 15, 2016 · 2 comments
Open

Better README #35

osxi opened this issue Sep 15, 2016 · 2 comments

Comments

@osxi
Copy link
Contributor

osxi commented Sep 15, 2016

The README is very lacking.

I think we should add some instructions for end developers and some notes for those interested in maintaining the addon.

Also, when the README is mature, https://emberobserver.com/addons/ember-date-range-picker will indicate that this project has grown past the WIP state.

@knittingdev
Copy link
Contributor

Here are a list of things I think we can document:

  • Usage of the different pickers
  • The options available for each picker
  • How to Start the dummy application
  • How to Contribute
  • Code of Conduct (I recommend we use http://contributor-covenant.org/)
  • Goals of the project
  • Versions used

@osxi
Copy link
Contributor Author

osxi commented Sep 21, 2016

Sounds good to me!

The only thing I can think of that might be important is:

  • Mentioning that the default blueprint needs to be run if you add the package to package.json manually or use npm install --save[-dev]
  • Mentioning any Ember version incompatibilities (haven't researched this at all with our addon)

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

No branches or pull requests

2 participants