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

Extend the README file #5

Open
danielmewes opened this issue Apr 7, 2015 · 1 comment
Open

Extend the README file #5

danielmewes opened this issue Apr 7, 2015 · 1 comment

Comments

@danielmewes
Copy link
Member

The readme should mention
a) what the demo is about (it just says "Examples using Node.js and RethinkDB" currently)
b) how to run the example
c) how to configure which server to connect to (edit the config.js file and point it to a running RethinkDB server)

(related to #4)

@danielmewes
Copy link
Member Author

Actually I only saw the global README. There are much better README.ms files in the individual implementation directories.

We should still improve the global README to describe what's in this repository and make it link to the other READMEs.

We should also clarify the other READMEs to say how to configure the application and that a RethinkDB server must be started first.
Here for example https://github.com/rethinkdb/rethinkdb-example-nodejs/tree/master/todo-angular-express we just say "Start the server with node app.js" which I can see to be confusing if you don't know that you also need to start the RethinkDB server separately.

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

1 participant