Skip to content

Commit 70ae5ce

Browse files
mtangooStefano Mtangoo
and
Stefano Mtangoo
authored
Fix composer to installable version. Update documentation (#295)
Co-authored-by: Stefano Mtangoo <stefano@hosannahighertech.co.tz>
1 parent 1fbd391 commit 70ae5ce

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,14 @@ The preferred way to install this extension is through [composer](http://getcomp
2323
Either run
2424

2525
```
26-
composer require --prefer-dist yiisoft/yii2-apidoc
26+
composer require --prefer-dist yiisoft/yii2-apidoc:"~3.0.6"
2727
```
2828

2929
The above command may not work on an existing project due to version conflicts that need to be resolved, so it
3030
is preferred to add the package manually to the `require` section of your composer.json:
3131

3232
```json
33-
"yiisoft/yii2-apidoc": "~2.1.0"
33+
"yiisoft/yii2-apidoc": "~3.0.6"
3434
```
3535

3636
afterwards run `composer update`. You may also run `composer update yiisoft/yii2-apidoc cebe/markdown` if you
@@ -39,13 +39,14 @@ want to avoid updating unrelated packages.
3939

4040
Usage
4141
-----
42+
This extension creates executable at `/vendor/bin`. Please do change directory to that directory if you do not want to use full path i.e `/vendor/bin/apidoc` and use just the executable name as with below examples.
4243

4344
This extension offers two commands:
4445

4546
1)`api` to generate class API documentation. [phpDocumentor](https://www.phpdoc.org/) is used as a base framework
4647
so refer to its guide for the syntax.
4748

48-
The output of `help api` command:
49+
The output of `help api` command (i.e `apidoc help api`):
4950

5051
```
5152
DESCRIPTION
@@ -106,7 +107,7 @@ OPTIONS
106107

107108
2)`guide` to render nice HTML pages from markdown files such as the yii guide.
108109

109-
The output of `help guide` command:
110+
The output of `help guide` command (i.e `apidoc help guide`):
110111

111112
```
112113
DESCRIPTION

0 commit comments

Comments
 (0)