Skip to content

Commit cefd379

Browse files
committed
🆙 Improve description of package
1 parent 1eb0e6b commit cefd379

File tree

4 files changed

+5
-3
lines changed

4 files changed

+5
-3
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010
[![Documentation](http://img.shields.io/badge/📜-Documentation-lightgrey.svg)](http://nelson6e65.github.io/phpdoc-vuepress)
1111

1212

13+
Template for generating your PHP API documentation in a pretty VuePress format.
14+
1315
This package provides a **phpDocumentor** template to generates the API documentation of your code to be integrated in a nice looking [VuePress](https://vuepress.vuejs.org) project.
1416

1517
> Only tested with the default theme of VuePress.

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "nelson6e65/phpdoc-vuepress",
3-
"description": "phpDocumentor template for VuePress.",
3+
"description": "Template for generating your PHP API documentation in a pretty VuePress format.",
44
"keywords" : [ "PHPDoc", "PHP", "phpDocumentor", "Documentation", "Markdown", "VuePress" ],
55
"homepage" : "https://github.com/nelson6e65/phpdoc-vuepress",
66
"license": "MIT",

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
home: true
33
heroText: "phpdoc-vuepress"
4-
tagline: Template for generating your PHP API documentation in a VuePress format.
4+
tagline: Template for generating your PHP API documentation in a pretty VuePress format
55
actionText: Get Started →
66
actionLink: /guide/
77

docs/guide/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
![License](https://img.shields.io/github/license/nelson6e65/phpdoc-vuepress.svg)
88

99
::: tip phpdoc-vuepress
10-
VuePress template for phpDocumentor.
10+
Template for generating your PHP API documentation in a pretty VuePress format.
1111
:::
1212

1313
This package provides a **phpDocumentor** template to generates the API documentation of your code to be integrated in a nice looking [VuePress](https://vuepress.vuejs.org) project.

0 commit comments

Comments
 (0)