igeligel / vue-readme

:books: Tool for creating readme's via your browser and configuration files. Easily create and manage your readme's of your GitHub repositories.

vue-readme by igeligel

Serverless vue.js application for creating project readmes in markdown.

Features

• Automatic contributor fetching via GitHub API
• Live preview for markdown

Installation

With node.js, npm and git installed run:

git clone https://github.com/igeligel/vue-readme
cd vue-readme
npm install
npm run dev

The application can then be accessed at http://localhost:8960.

To create a production build on the gh-pages branch run:

npm run build

License

vue-readme is released under the MIT License.