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

Readme is unclear that this is a client-side library, no server needed #410

Closed
knod opened this issue Nov 25, 2015 · 2 comments
Closed

Readme is unclear that this is a client-side library, no server needed #410

knod opened this issue Nov 25, 2015 · 2 comments

Comments

@knod
Copy link

knod commented Nov 25, 2015

To beginners with this stuff, it's not clear from the README on the front page of the repo that no server is needed to use Keyboard. It's an issue a lot of repos have. This one is especially confusing because the README describes installing it with node, which is often an indication that stuff will be happening with a server. You can actually just download the zip file.

The setup page helps if someone goes to the wiki and then knows what they're looking for, but it'd be great to have it stated clearly up front.

@Mottie
Copy link
Owner

Mottie commented Nov 25, 2015

Hi @knod!

Yeah, I've been neglecting the main readme. I'll work on updating it. Thanks!

@knod
Copy link
Author

knod commented Nov 26, 2015

Thanks @Mottie!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants