You should add more detail to the project's read me file.
Fix your markdown
First, your markdown is wrong. Your readme uses a format called "Markdown". This is a way of "annotating" plain text and converting it into rich text. This is super useful in github and slack and indeed your code.
Your readme on github looks like this:
It's very shouty, untidy, and hard to read.
If I write Markdown like this:
# This is my title
This is *bold* text. I can do [links](https://www.markdownguide.org/cheat-sheet) too.
I can also do code:
How to install/set it up on my computer (the vite instuctions you used to have used to include this!)
How to start the app (ie run npm run start and to to locahost:8000)
Remember that writing good documentation is about capturing the important details as briefly as possible. If someone had never seen your code project before, what would you want them to know?
This is what most people include in their readmes (look at react, lodash, vite, react-router on npm - see what they include).
What prerequisites need to be installed to run the app (nodejs)
How to run tests
How to contribute code
How to contact the creator
Examples of how to use the code
What features will be added in the future
If there are requirements for the project, what they are (ie, WHY this project was created - if it's a response to a code test, include the test question here)
You should add more detail to the project's read me file.
Fix your markdown
First, your markdown is wrong. Your readme uses a format called "Markdown". This is a way of "annotating" plain text and converting it into rich text. This is super useful in github and slack and indeed your code.
Your readme on github looks like this:
It's very shouty, untidy, and hard to read.
If I write Markdown like this:
const x = 10
It'll render like this:
This is my title
This is bold text. I can do links too.
I can also do code:
Add more details
Your intro sentence in the readme is great.
But you also need to tell me:
npm run startand to tolocahost:8000)Remember that writing good documentation is about capturing the important details as briefly as possible. If someone had never seen your code project before, what would you want them to know?
This is what most people include in their readmes (look at
react,lodash,vite,react-routeron npm - see what they include).Not all of this is relevant for your of course!