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

[WIP] Updates to readme and license #1063

Closed
wants to merge 3 commits into from
Closed

[WIP] Updates to readme and license #1063

wants to merge 3 commits into from

Conversation

joshbruce
Copy link
Member

Working on preparing to add @Feder1co5oave and @UziTech to the list of folks who can publish to NPM as well as possibly breaking up the README into separate files to help users out a bit as well.

screen shot 2018-02-18 at 10 31 38 pm

@styfle
Copy link
Member

styfle commented Feb 21, 2018

I wonder if we should make the README smaller (since this gets published to NPM) and move most of the docs into the /docs. Then this folder can be used for GitHub Pages users can get a nice web view of the docs as well as a working demo. Then we can add /docs to .npmignore file so it doesn't get published.

This pattern can be seen here: https://github.com/styfle/copee

@joshbruce
Copy link
Member Author

@styfle: I've seen a similar pattern to allow GitHub Pages. Also been thinking a bit about the whole GitHub Pages thing as well.

Having said all that, totally agree on breaking up the README. It's on my list of things to do. Maybe it will become a GH Pages site here or in a different repo (not that we have the org thing going on); not sure.

In either case - it look like GitHub and I got very out of sync somehow. So, going to close this and work on a resubmission.

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