Skip to content

mpittas/readme-gen

Repository files navigation

Logo

Vercel Deploy MIT License

Demo

Live preview: README.GEN


About

This is an interactive application for generating readme.md files for your github application quikcly and easy.

Your support is invaluable. If you appreciate this project, consider giving it a star on GitHub.


Features

  • Entirely written is Typescript
  • Light/dark mode toggle
  • Live previews
  • Responsive design
  • Slick and modern design

Feedback

If you have any feedback, please reach out to [email protected]


Installation

Install my-project with npm

# navigate to projecr:
npm install
yarn install

# run project
npm run dev
yarn dev