From d59a8da813491d4cfad188adb0e3fc7a2306f835 Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Wed, 24 Jan 2018 12:02:38 +0100 Subject: Add api documentation in readme --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index e8871a7cc..491b09a36 100644 --- a/README.md +++ b/README.md @@ -147,6 +147,13 @@ guide](/.github/CONTRIBUTING.md) to see how to contribute to PeerTube. Spoiler alert: you don't need to be a coder to help! +## API REST documentation + +For now only on Github: + + * HTML version: [/support/doc/api/html/index.html](/support/doc/api/html/index.html) + * Swagger/OpenAPI schema: [/support/doc/api/openapi.yaml](/support/doc/api/openapi.yaml) + ## Architecture See [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation. -- cgit v1.2.3