DEV Community

Cover image for Create nice Readmes for your open source projects ✨
Avneesh Agarwal for ByteSlash

Posted on • Originally published at blog.avneesh.tech

10 1

Create nice Readmes for your open source projects ✨

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
Enter fullscreen mode Exit fullscreen mode

After running this command, it will ask you a bunch of questions for adding in the readme.

image.png
After you have answered all the questions it will create a README.md file for you that looks like this-

view raw readme.md hosted with ❤ by GitHub

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.

image.png

2. Readme.so

If you want to build a more customized Readme, then this is a great tool built by @Katherine Peterson.

image.png

By just clicking some buttons and editing some text, I got a nice readme like this-

My project

Tech Stack

Client: React, Redux, TailwindCSS

Server: Node, Express

Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Please adhere to this project's code of conduct.

Installation

Install my-project with npm

  npm install my-project
  cd my-project

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

API_KEY

ANOTHER_API_KEY

Running Tests

To run tests, run the following command

  npm run test

Deployment

To deploy this project run

  npm run deploy

Authors

🚀 About Me

I'm a full-stack developer...

Hi, I'm Avneesh! 👋

🔗 Links

portfolio linkedin twitter

🛠 Skills

Javascript, HTML, CSS...

License

MIT

view raw readme.md hosted with ❤ by GitHub

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-

Readme MD generator

Readme.so

All socials

Top comments (0)

Heroku

This site is built on Heroku

Join the ranks of developers at Salesforce, Airbase, DEV, and more who deploy their mission critical applications on Heroku. Sign up today and launch your first app!

Get Started