diff options
| author | Chocobozzz <me@florianbigard.com> | 2018-01-24 12:02:38 +0100 |
|---|---|---|
| committer | Chocobozzz <me@florianbigard.com> | 2018-01-24 12:02:38 +0100 |
| commit | d59a8da813491d4cfad188adb0e3fc7a2306f835 (patch) | |
| tree | 03cf4099251431100c48b13fdcfcad673940d10f /README.md | |
| parent | 5e1c08eb94746c44b8b14a12c0937aadb34feb57 (diff) | |
| download | PeerTube-d59a8da813491d4cfad188adb0e3fc7a2306f835.tar.gz PeerTube-d59a8da813491d4cfad188adb0e3fc7a2306f835.tar.zst PeerTube-d59a8da813491d4cfad188adb0e3fc7a2306f835.zip | |
Add api documentation in readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 7 |
1 files changed, 7 insertions, 0 deletions
| @@ -147,6 +147,13 @@ guide](/.github/CONTRIBUTING.md) | |||
| 147 | to see how to contribute to PeerTube. Spoiler alert: you don't need to be a | 147 | to see how to contribute to PeerTube. Spoiler alert: you don't need to be a |
| 148 | coder to help! | 148 | coder to help! |
| 149 | 149 | ||
| 150 | ## API REST documentation | ||
| 151 | |||
| 152 | For now only on Github: | ||
| 153 | |||
| 154 | * HTML version: [/support/doc/api/html/index.html](/support/doc/api/html/index.html) | ||
| 155 | * Swagger/OpenAPI schema: [/support/doc/api/openapi.yaml](/support/doc/api/openapi.yaml) | ||
| 156 | |||
| 150 | ## Architecture | 157 | ## Architecture |
| 151 | 158 | ||
| 152 | See [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation. | 159 | See [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation. |