From 8fa2204afe8b6ee6fe758f51f438495ca17e0659 Mon Sep 17 00:00:00 2001 From: James Kasten Date: Fri, 27 Mar 2015 12:29:27 -0700 Subject: [PATCH] Add disclaimer in plugins doc --- docs/plugins.rst | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/plugins.rst b/docs/plugins.rst index fafb8d5d3..0451bfe3f 100644 --- a/docs/plugins.rst +++ b/docs/plugins.rst @@ -5,9 +5,15 @@ Plugins Let's Encrypt client supports dynamic discovery of plugins through the `setuptools entry points`_. This way you can, for example, create a custom implementation of -`~letsencrypt.client.interfaces.IAuthenticator` without having to -merge it with the core upstream source code. Example is provided in +`~letsencrypt.client.interfaces.IAuthenticator` or the +'~letsencrypt.client.interfaces.IInstaller' without having to +merge it with the core upstream source code. An example is provided in ``examples/plugins/`` directory. +Please be aware though that as this client is still in a developer-preview +stage, the API may undergo a few changes. If you believe the plugin will be +beneficial to the community, please consider submitting a pull request to the +repo and we will update it with any necessary API changes. + .. _`setuptools entry points`: https://pythonhosted.org/setuptools/setuptools.html#dynamic-discovery-of-services-and-plugins