Skip to content

Latest commit

 

History

History
31 lines (20 loc) · 810 Bytes

README.md

File metadata and controls

31 lines (20 loc) · 810 Bytes

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.