Read.me is a tool to help people create awesome readmes for their open-source projects, without having to learn markdown.
- Dynamically build your readme with pre-made, low-level markdown components.
- Preview your readme live, as you create it.
- [coming soon] Deploy your readme directly to your github repo!
- SvelteKit
- Tailwind CSS
- Svelte Markdown
- GitHub Markdown CSS
This application has been released under and MIT licence, meaning that people are completely free to do whatever they want with it.
To get started, clone the repo locally, and run the following commands:
npm install
npm run dev
and them navigate to https://localhost:3000
This application was heavily inspired by readme.so, a project that has many similar features to this . Please send love and support to Katherine, the creator of readme.so. Thanks Katherine ❤