To start with this issues, any repository's readme is the first place that a developer starts with, it's the documentation that will make one understand what, how, who made this project and why the have built it.
Therefore, it's something like a website interface that comes in top of a complex back-end code, and that's why it should be ERROR FREE and tidy.
In this readme, I have found lots of typos, I will showcase some of them, but you will have to do a revision yourself.
First of all, your readme starts with Title phrase. which I suppose must be changed to Later-team which is your brand name!
In this line, fix some words and make the pretty, also, there is no need to have a numbered list since the list containes only one list item:
when you choose any project you want, the page will be updated the project's details which includes:
1. The project's photo.
This could simply be: After searching for a project, the page will be updated with the project details which includes its photo. cool, right?
In The file structure: section, you have started describing the content of public folder, which is not exactly the main directory for your project. Instead, you shoud step back one step and start descriping the root directory, such like:
Sections How? & Splitting the work need some revision.
:warning: Section API's that we used:, first of all, you dont have to include the full path that you have used in your project when showing people what APIs you have used in your project, the next part is the most important one. :x: :heavy_multiplication_x: :warning: DON'T EVER put your API KEY \ CLIENT ID or any sensitive data in a public place, such like the readme, also the project files!
Section How to run, I think the steps you included should be shown in a numbered list:
1. Clone the repo..... (describe how it's done)
2. cd Later-team
3. npm install
4. In your browser: navigate to .....
Hello there,
To start with this issues, any repository's readme is the first place that a developer starts with, it's the documentation that will make one understand what, how, who made this project and why the have built it.
Therefore, it's something like a website interface that comes in top of a complex back-end code, and that's why it should be ERROR FREE and tidy.
In this readme, I have found lots of typos, I will showcase some of them, but you will have to do a revision yourself.
First of all, your readme starts with
Titlephrase. which I suppose must be changed toLater-teamwhich is your brand name!In this line, fix some words and make the pretty, also, there is no need to have a numbered list since the list containes only one list item:
This could simply be:
After searching for a project, the page will be updated with the project details which includes its photo.cool, right?In
The file structure:section, you have started describing the content ofpublicfolder, which is not exactly the main directory for your project. Instead, you shoud step back one step and start descriping the root directory, such like:Sections
How?&Splitting the workneed some revision.:warning: Section
API's that we used:, first of all, you dont have to include the full path that you have used in your project when showing people what APIs you have used in your project, the next part is the most important one. :x: :heavy_multiplication_x: :warning: DON'T EVER put yourAPI KEY \ CLIENT IDor any sensitive data in a public place, such like the readme, also the project files!Section
How to run, I think the steps you included should be shown in a numbered list: