https://github.com/rawnly/web-readme
Super simple website readme generator
https://github.com/rawnly/web-readme
Last synced: 7 months ago
JSON representation
Super simple website readme generator
- Host: GitHub
- URL: https://github.com/rawnly/web-readme
- Owner: rawnly
- Created: 2021-08-18T20:07:00.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-08-18T20:11:37.000Z (almost 5 years ago)
- Last Synced: 2024-12-28T09:43:26.294Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 11.7 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Website Readme Generator
> Super simple website readme generator.
## Installation
```
npm i -g web-readme
# or
yarn global add web-readme
```
## How it works
It uses puppeteer to take a screenshot of the website and fills the super simple readme template with configuration params.
You have to create a new file named `readme.config.json` with: `name`, `description` and `url`.
Those fields will be used to take the screenshot of the website and fill the template.