From 09134ea62d8fdad68da18b0e9d211a6229065e41 Mon Sep 17 00:00:00 2001 From: Gajus Kuizinas Date: Sun, 17 Sep 2017 13:17:28 +0100 Subject: [PATCH] docs: document API --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index a1cfb29..c7bd030 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,14 @@ const tmdb = new Tmdb(apiKey); ``` +### API + +Refer to the [source code](./src/Tmdb.js) and the [type definitions](./src/types.js). + +> Note: Only a subset of the API is implemented. I will be adding new methods as needed. +> If you need a method added, raise a PR. Alternatively, you can use the low-level `get` +> method to construct any API calls. + ### Handling errors Methods that are expected to return a specific resource will throw `NotFoundError` if the resource is not found.