Hello guys, once again I'm here with a small tutorial for you guys new on the business. Even though my repos have never got a lot of attention, I like that they have a good readme.
Knowing that lets just go to the point.
Before publish your own README
let me tell you what you need to change, you will see that they are some and . well that's where you will change to your Github user and to your Github repo name.
Plus you will see some quick explanation saying what you should put there, they are marked with this [ ].
With nothing else to say, take a look.
Here is a picture of the markdown code
And here you can get the raw code
[here we add the necesary badges, here are the ones I say we always need]
[short description of the repo]
this app is made for myself
[Just a quick explanation about why you are making this project]
just for fun and learning
[Here you will place the necessary commands to clone and run your project]
> git clone https://github.com/<User>/<Repo>
> cd <Repo>
> npm install
> npm start
[Here you will place what to do if someone have a bug, and they will report it]
This project is getting upgrades in my free time if there is a problem please create a bug report in the issues section.
[Here you simply, add your repos license name]
- Licensed under MIT License
Top comments (4)
This is great! For projects that have collaborators, I like to add a Code of Conduct as well.
Thanks! Actually there are some good basic code of conducts, that people use, I think one is atom's one
Thanks!
Amazing 😍👌😍