Creating good Readmes for your open source project is very important to get some popularity, stars, forks, and contributors. So today we are going to look at 2 ways to create beautiful Readmes.
1. Readme-md-generator
This CLI tool generates a great looking in a few minutes. To use this tool run-
npx readme-md-generator
After running this command, it will ask you a bunch of questions for adding in the readme.
After you have answered all the questions it will create a README.md file for you that looks like this-
This project teaches how to create nice readmes
🏠 Homepage
✨ Demo
yarn install
yarn dev
👤 Avneesh Agarwal
- Website: https://www.avneesh.tech/
- Twitter: @avneesh0612
- Github: @avneesh0612
- LinkedIn: @avneesh-agarwal-78312b20a
Give a ⭐️ if this project helped you!
This README was generated with ❤️ by readme-md-generator
Now you can edit and tweak it as per your need.
Quick hack
If you want to preview the readme directly hit ctrl + shift + V and it will show you a live preview.
2. Readme.so
If you want to build a more customized Readme, then this is a great tool built by @Katherine Peterson.
By just clicking some buttons and editing some text, I got a nice readme like this-
Client: React, Redux, TailwindCSS
Server: Node, Express
Contributions are always welcome!
See contributing.md
for ways to get started.
Please adhere to this project's code of conduct
.
Install my-project with npm
npm install my-project
cd my-project
To run this project, you will need to add the following environment variables to your .env file
API_KEY
ANOTHER_API_KEY
To run tests, run the following command
npm run test
To deploy this project run
npm run deploy
I'm a full-stack developer...
Javascript, HTML, CSS...
I hope you could make some nice Readmes for your open source projects with these amazing tools.
What tools do you use for making your Readme? Let me know in the comments 👇
Useful links-
Top comments (0)