| 1 | # Vue GitHub Buttons
|
| 2 |
|
| 3 | GitHub buttons component for Vue.
|
| 4 |
|
| 5 | ## Install
|
| 6 |
|
| 7 | ```bash
|
| 8 | yarn add vue-github-buttons
|
| 9 | ```
|
| 10 |
|
| 11 | ## Usage
|
| 12 |
|
| 13 | ```js
|
| 14 | import VueGitHubButtons from 'vue-github-buttons'
|
| 15 |
|
| 16 | //... your code
|
| 17 | ```
|
| 18 |
|
| 19 | ## Folder structure
|
| 20 |
|
| 21 | - `src/`: Source files for this component
|
| 22 | - `example/`: Example for demonstrating this component
|
| 23 | - `index.js`: Entry for the example
|
| 24 | - `App.vue`: The root component which we use to load this component
|
| 25 | - `vbuild.example.js`: Config file for your example
|
| 26 | - `vbuild.component.js`: Config file for your component
|
| 27 | - `vbuild.unit.js`: Config file for vbuild to run unit tests
|
| 28 | - `package.json`: App manifest
|
| 29 | - `.editorconfig`: Ensure consistent editor behaivor
|
| 30 | - `.gitignore`: Ignore files we don't need to push
|
| 31 |
|
| 32 | ## Development
|
| 33 |
|
| 34 | - `yarn example`: Run example in development mode
|
| 35 | - `yarn deploy`: Deploy example to gh-pages
|
| 36 | - `yarn build:cjs`: Build component in commonjs format
|
| 37 | - `yarn build:umd`: Build component in umd format
|
| 38 | - `yarn build`: Build component in both format
|
| 39 | - `yarn lint`: Run eslint
|
| 40 | - `yarn test:unit`: Run unit tests using [vbuild-karma](https://github.com/egoist/vbuild-karma)
|
| 41 |
|
| 42 | Check out your npm scripts, it's using [vbuild](https://github.com/egoist/vbuild) under the hood.
|
| 43 |
|
| 44 | ---
|
| 45 |
|
| 46 | Generated by [create-vue-app](https://github.com/egoist/create-vue-app)
|