Skip to content

Commit 4b992eb

Browse files
committed
🎨 🆕 badges to README
1 parent 62ea71d commit 4b992eb

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# phpDocumentor VuePress template
22

3+
[![GitHub release](https://img.shields.io/github/tag/nelson6e65/phpdoc-vuepress.svg)](https://github.com/nelson6e65/phpdoc-vuepress/tags)
4+
[![Latest Version](https://img.shields.io/packagist/v/nelson6e65/phpdoc-vuepress.svg?label=stable)](https://packagist.org/packages/nelson6e65/phpdoc-vuepress)
5+
[![Latest unstable Version](https://img.shields.io/packagist/vpre/nelson6e65/phpdoc-vuepress.svg?label=unstable)](https://packagist.org/packages/nelson6e65/phpdoc-vuepress#dev-master)
6+
7+
[![License](https://img.shields.io/github/license/nelson6e65/phpdoc-vuepress.svg)](LICENSE)
8+
9+
310
[phpDocumentor template](http://www.phpdoc.org/docs/latest/getting-started/changing-the-look-and-feel.html) that generates [VuePress](https://vuepress.vuejs.org) documentation of your API.
411

512
The main use-case for this template is to generate simple and nice looking API documentation pages to be integrated in a VuePress project.
@@ -22,7 +29,7 @@ composer require --dev nelson6e65/phpdoc-vuepress
2229

2330
> At the moment, this package has not PHP dependencies for usage,
2431
25-
32+
> You may need to set the composer option [minimum-stability](https://getcomposer.org/doc/04-schema.md#minimum-stability) to 'dev' in order to be able to install pre-releases.
2633
2734
## Usage
2835

0 commit comments

Comments
 (0)