Skip to content

Commit

Permalink
clean up in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
petrparolek authored and f3l1x committed Feb 20, 2023
1 parent 957ce1a commit 05a3c24
Showing 1 changed file with 2 additions and 11 deletions.
13 changes: 2 additions & 11 deletions .docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ ApiDocu can generate api documentation for routes created using [ApiRouter](http
## Content

- [Content](#content)
- [Installing ApiDocu](#installing-apidocu)
- [Usage - runtime documentation](#usage---runtime-documentation)
+ [GET routes](#get-routes)
+ [PUT, POST, DELETE routes](#put--post--delete-routes)
Expand All @@ -14,14 +13,6 @@ ApiDocu can generate api documentation for routes created using [ApiRouter](http
+ [`?__apiDocuGenerate`](#----apidocugenerate-)
- [HTTP authorization](#http-authorization)

## Installing ApiDocu

ApiDocu is available through composer package `contributte/api-docu`:

```bash
composer require contributte/api-docu
```

## Usage - runtime documentation

![Route docs](assets/route-docs.png)
Expand All @@ -46,7 +37,7 @@ use Contributte\ApiRouter\ApiRoute;

/**
* API for managing users
*
*
* @ApiRoute(
* "/api-router/api/users[/<id>]",
* parameters={
Expand Down Expand Up @@ -85,7 +76,7 @@ class UsersPresenter extends Nette\Application\UI\Presenter
* }}
* }
* </json>
*
*
* @ApiRoute(
* "/api-router/api/users/<id>[/<foo>-<bar>]",
* parameters={
Expand Down

0 comments on commit 05a3c24

Please sign in to comment.