search

ecdeveloper / node-web-crawler

A web scraper with a web user interface which shows scraping stats in realtime. Uses Node.JS, jQuery, socket.io and Express.
MIT License
104 stars 40 forks source link

For README.md clarity #17

Open jaredmansaakintola opened 9 years ago

jaredmansaakintola commented 9 years ago

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 commented 9 years ago

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.