https://github.com/dawsbot/meread
🙌🤖🙌 Automating a beautiful readme
https://github.com/dawsbot/meread
Last synced: 11 months ago
JSON representation
🙌🤖🙌 Automating a beautiful readme
- Host: GitHub
- URL: https://github.com/dawsbot/meread
- Owner: dawsbot
- License: mit
- Created: 2015-09-27T04:40:24.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-03-01T17:19:41.000Z (over 10 years ago)
- Last Synced: 2025-07-14T13:47:03.764Z (12 months ago)
- Language: JavaScript
- Homepage:
- Size: 1.1 MB
- Stars: 8
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Make your README's suck less using meread's templating.
## Installation
```shell
npm install -g meread
```
## Usage
```shell
meread
```
## Motivation
Engineers are famous for being entirely focused on the hack. From the technical implementation to pounding out the code, README files are often forgotten. When others want to see and learn from your code they head to your README file. Without loving, it is probably a mess.
Use ```meread``` to make quick and clean readme files. Have a designer build the template or just stick to the prebuilt template we provide in order to get your information out to an audience in a presentable way!
## Changelog
* **0.\*.\*-prelaunch**: Prelaunch Beta Testing