search

taheroo / node-authentication

Simple Nodejs Authentication System
0 stars 0 forks source link

[ documentation, good first issue ] - README file #1

Open tashachin opened 3 years ago

tashachin commented 3 years ago

Several questions come to mind here:

  1. I'm curious about the "base" modifier (adjective) before the dependencies. Could you clarify why you call them "base"? (This could simply be me not knowing the terminology.)
  2. I would replace the Usage header with How to Install
  3. I would clarify that the installation guide is via the command line interface (CLI). (I'm defining the initialism here just for anyone who stumbles upon this. Most devs will know what "CLI" means.)
  4. I suggest changing Folder structure to Project structure because while they are folders, there are also assets and files, therefore the entire repository is a "project".
  5. A possible enhancement is a Further Reading or Resources section for anyone new to the Node.js stack.
taheroo commented 3 years ago

Thank you for opening an issue about the documentation.

  1. With Base dependencies, I mean the required dependencies that will be installed to successfully run the project.
tashachin commented 3 years ago

@taheroo - I think it would be easy enough for someone to edit the README on Github directly, but if you wanted to teach someone how to use Git via the CLI, you'd want to breakdown that workflow for someone.