mirror of
https://github.com/quantum5/cfwatch.git
synced 2025-04-24 11:31:58 -04:00
Update and rename README.md to README.rst
This commit is contained in:
parent
2a141d86b3
commit
d7d000eda0
|
@ -1,2 +0,0 @@
|
||||||
# cloudflare-watchdog
|
|
||||||
Automagically purges CloudFlare's cache when files are updated
|
|
37
README.rst
Normal file
37
README.rst
Normal file
|
@ -0,0 +1,37 @@
|
||||||
|
``cfwatch`` |pypi|
|
||||||
|
==================
|
||||||
|
|
||||||
|
Automagically purges CloudFlare's cache when local files are updated.
|
||||||
|
|
||||||
|
This is useful for exporting a directory of files via CloudFlare. If
|
||||||
|
your files are updated, ``cfwatch`` will automatically purge the
|
||||||
|
corresponding URL on CloudFlare.
|
||||||
|
|
||||||
|
With ``cfwatch``, you will no longer need to add cache busting query
|
||||||
|
strings, and the direct link will always work.
|
||||||
|
|
||||||
|
Usage
|
||||||
|
-----
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
$ pip install cfwatch
|
||||||
|
$ cfwatch --help
|
||||||
|
usage: cfwatch.py [-h] [-l LOG] email token zone prefix [dir]
|
||||||
|
|
||||||
|
Purges CloudFlare on local file change.
|
||||||
|
|
||||||
|
positional arguments:
|
||||||
|
email CloudFlare login email (e.g. user@example.com)
|
||||||
|
token CloudFlare API key (e.g.
|
||||||
|
c2547eb745079dac9320b638f5e225cf483cc5cfdda41)
|
||||||
|
zone CloudFlare zone (e.g. example.com)
|
||||||
|
prefix CloudFlare path prefix (e.g. http://example.com/)
|
||||||
|
dir directory to watch, i.e. file.txt this directory is
|
||||||
|
http://example.com/file.txt
|
||||||
|
|
||||||
|
optional arguments:
|
||||||
|
-h, --help show this help message and exit
|
||||||
|
-l LOG, --log LOG log file
|
||||||
|
|
||||||
|
.. |pypi| image:: https://img.shields.io/pypi/v/cfwatch.svg
|
Loading…
Reference in a new issue