diff --git a/README.md b/README.md index 534a95b..7d69a30 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,21 @@ -# Customizable Cloudflare error page generator +# Cloudflare Error Page Generator -## QuickStart Guide (Python) +## What does this project do? + +This project creates customized error pages that mimics Cloudflare's error page. And you can embed it into your website. + +![Default error page](doc/default.png) + +## Quickstart + +Install cloudflare-error-page using pip ``` Bash pip install git+https://github.com/donlon/cloudflare-error-page.git ``` +Then you can generate an error page based on parameters you like. (See [example.py](examples/example.py)) + ``` Python import webbrowser from cloudflare_error_page import render as render_cf_error_page @@ -34,7 +44,9 @@ with open('error.html', 'w') as f: webbrowser.open('error.html') ``` -## Examples +## More Examples + +### Catastrophic infrastructure failure ``` Python params = { diff --git a/doc/default.png b/doc/default.png new file mode 100644 index 0000000..b182ef5 Binary files /dev/null and b/doc/default.png differ