https://github.com/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.
https://github.com/igeligel/vue-readme

git nodejs npm readme readme-template vue vue2 vuejs vuejs2 vuex vuex2

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/igeligel/vue-readme
• Owner: igeligel
• License: mit
• Created: 2017-03-22T18:18:57.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2021-03-03T07:29:28.000Z (almost 4 years ago)
• Last Synced: 2024-04-14T23:52:26.605Z (9 months ago)
• Topics: git, nodejs, npm, readme, readme-template, vue, vue2, vuejs, vuejs2, vuex, vuex2
• Language: Vue
• Homepage: https://igeligel.github.io/vue-readme
• Size: 1020 KB
• Stars: 6
• Watchers: 3
• Forks: 4
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# vue-readme by [igeligel](https://github.com/igeligel)

> Serverless [vue.js](https://vuejs.org/) application for creating project readmes in markdown.

## Features

- Automatic contributor fetching via [GitHub API](https://developer.github.com/v3/)

- Live preview for markdown

## Installation

With [node.js](https://nodejs.org/en/), [npm](https://www.npmjs.com/) and [git](https://git-scm.com) installed run:

```bash

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](http://localhost:8960).

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

```bash

npm run build

```

## License

vue-readme is released under the [MIT License](https://github.com/igeligel/vue-readme/blob/master/LICENSE).