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

For README.md clarity #17

Open
jaredmansaakintola opened this issue Feb 15, 2015 · 1 comment
Open

For README.md clarity #17

jaredmansaakintola opened this issue Feb 15, 2015 · 1 comment

Comments

@jaredmansaakintola
Copy link

For clarity and easy of use for new users to both Github and your particular application the following line in the README.md could be updated from:

"And then install dependencies:"
to:
"Navigate to directory 'node-web-crawler' then install dependencies:"

and the command could then read:
cd node-web-crawler; npm install

@jaredmansaakintola
Copy link
Author

As well as the need to have Mongodb running to execute the command "node app", I'm looking into a way to write this into the program so the user can follow the instructions on the README.md as they currently are but if there is no such change that can be made I would suggest writing that step into the documentation. Upon forking the project, to try to submit changes to the README.md, I found that cannot view the README.md properly I see

screen shot 2015-02-15 at 2 06 07 pm

Im not sure if this is just me though.

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