Described the change to the enviornment variables

markllama · Mar 30, 2022 · f9486e6 · f9486e6
1 parent 2c4ee60
commit f9486e6
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -209,6 +209,19 @@ There is one call that presently doesn't need any email or token certification (
 
 ### Using shell environment variables
 
+Note (for latest vewrsion of code):
+
+ * `CLOUDFLARE_EMAIL` has replaced `CF_API_EMAIL`.
+ * `CLOUDFLARE_API_KEY` has replaced `CF_API_KEY`.
+ * `CLOUDFLARE_API_CERTKEY` has replaced `CF_API_CERTKEY`.
+
+Additionally, these two variables are available for testing purposes:
+
+ * `CLOUDFLARE_API_EXTRAS` has replaced `CF_API_EXTRAS`.
+ * `CLOUDFLARE_API_URL` has replaced `CF_API_URL`.
+
+The older environment variable names can still be used.
+
 ```bash
 $ export CLOUDFLARE_EMAIL='user@example.com' # Do not set if using an API Token
 $ export CLOUDFLARE_API_KEY='00000000000000000000000000000000'

diff --git a/README.rst b/README.rst
@@ -214,6 +214,19 @@ There is one call that presently doesn’t need any email or token certification
 Using shell environment variables
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+Note (for latest vewrsion of code):
+
+-  ``CLOUDFLARE_EMAIL`` has replaced ``CF_API_EMAIL``.
+-  ``CLOUDFLARE_API_KEY`` has replaced ``CF_API_KEY``.
+-  ``CLOUDFLARE_API_CERTKEY`` has replaced ``CF_API_CERTKEY``.
+
+Additionally, these two variables are available for testing purposes:
+
+-  ``CLOUDFLARE_API_EXTRAS`` has replaced ``CF_API_EXTRAS``.
+-  ``CLOUDFLARE_API_URL`` has replaced ``CF_API_URL``.
+
+The older environment variable names can still be used.
+
 .. code:: bash
 
    $ export CLOUDFLARE_EMAIL='user@example.com' # Do not set if using an API Token