From d9830590f3f7048572a958c158d5b0aa5f1d8e70 Mon Sep 17 00:00:00 2001 From: Spain Date: Mon, 14 Nov 2016 20:39:11 -0500 Subject: [PATCH] docs: Enumerate `Client` constructor args - Document the kwargs that the `Client` class constructor accepts --- README.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.rst b/README.rst index 43bcfe4..d255307 100644 --- a/README.rst +++ b/README.rst @@ -27,6 +27,13 @@ The ``Client`` class manages all your interaction with the Contentful Delivery A client = Client('space-id', 'access-token') +The constructor also takes the following keyword arguments: + +- ``custom_entries`` (list) Optional list of `Entry` subclasses (see below) +- ``secure`` (bool) Indicates whether the connection should be encrypted or not, default: ``True`` +- ``endpoint`` (str) Custom remote API endpoint, default: ``cdn.contentful.com`` +- ``resolve_links`` (bool) Indicates whether or not to resolve links automatically, default: ``True`` + ------------------ Fetching Resources ------------------