Skip to content

Commit 11cb7db

Browse files
committed
Update readme with user information
1 parent 2c0ff9b commit 11cb7db

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,26 @@
1-
# shim
2-
phpDocumentor phar as composer package
1+
# phpDocumentor phar distribution.
2+
3+
This package allows users to install phpDocumentor via composer.
4+
Using the distributed phar's from the [phpDocumentor main repo](https://github.com/phpDocumentor/phpDocumentor).
5+
This package only provides an installer.
6+
New tags are created when a new version of phpDocumentor is released.
7+
If you want to use a bleeding edge version of phpDocumentor please consult the main repo.
8+
9+
## Usage
10+
11+
Add phpdocumentor to your project.
12+
13+
```
14+
composer require --dev phpdocumentor/shim:3^
15+
```
16+
17+
phpDocumentor phar will be downloaded and adding into your projects `bin` directory.
18+
Which is `vendor/bin` by default.
19+
20+
From now, you can follow the normal flow to use phpDocumentor.
21+
For more information about using phpDocumentor please read our [docs](https://docs.phpdoc.org/latest).
22+
23+
## Report issues
24+
25+
If you have any issues using phpDocumentor please report bugs in the [main repo](https://github.com/phpDocumentor/phpDocumentor/issues)
26+

0 commit comments

Comments
 (0)