Skip to content

Commit e6f102b

Browse files
committed
Improve Usage readablility
1 parent 433af9b commit e6f102b

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
11
# PHP-Drafter
22
This is a parser for API Blueprint files in PHP.
33

4+
## Usage
5+
For direct usage you can run:
6+
```bash
7+
$ ./php-drafter.phar blueprint-file.apib > blueprint-webpage.html
8+
```
9+
You can also install it first:
10+
```bash
11+
$ cp php-drafter.phar /usr/bin/php-drafter
12+
$ chmod +x /usr/bin/php-drafter
13+
$ php-drafter blueprint-file.apib > blueprint-webpage.html
14+
```
15+
416
## Writing API documentation
517

618
For writing API documentation using [API Blueprint](http://apiblueprint.org/) syntax. You can read about its [specification](https://github.com/apiaryio/api-blueprint/blob/master/API%20Blueprint%20Specification.md).
@@ -51,22 +63,10 @@ Return the information for the Person
5163

5264
```
5365

54-
## Usage
55-
For direct usage you can run:
56-
```bash
57-
$ ./php-drafter.phar blueprint-file.apib > blueprint-webpage.html
58-
```
59-
You can also install it first:
60-
```bash
61-
$ cp php-drafter.phar /usr/bin/php-drafter
62-
$ chmod +x /usr/bin/php-drafter
63-
$ php-drafter blueprint-file.apib > blueprint-webpage.html
64-
```
6566

6667
## Dependencies
67-
6868
PHP-Drafter requires [drafter](https://github.com/apiaryio/drafter) to be installed. Refer to the drafter page for the installation details.
6969

70-
### Libraries
70+
## Libraries
7171
This app usage the following libraries:
7272
* https://github.com/michelf/php-markdown.git

0 commit comments

Comments
 (0)