diff --git a/README.md b/README.md index 7d69a30..fffe98b 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,7 @@ ## 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) +This project creates customized error pages that mimics the well-known Cloudflare's error page. You can also embed it into your website. ## Quickstart @@ -44,6 +42,8 @@ with open('error.html', 'w') as f: webbrowser.open('error.html') ``` +![Default error page](doc/default.png) + ## More Examples ### Catastrophic infrastructure failure @@ -81,6 +81,36 @@ params = { ![Catastrophic infrastructure failure](doc/example.png) +### Web server is working + +``` Python +params = { + 'title': 'Web server is working', + 'error_code': 200, + "more_information": { + "hidden": True, + }, + 'browser_status': { + 'status': 'ok', + 'status_text': 'Seems Working', + }, + 'cloudflare_status': { + 'status': 'ok', + 'status_text': 'Often Working', + }, + 'host_status': { + 'status': 'ok', + 'location': 'example.com', + 'status_text': 'Just Working', + }, + 'error_source': 'host', + 'what_happened': '

This site is still working. And it looks great.

', + 'what_can_i_do': '

Visit the site before it crashes someday.

', +} +``` + +![Web server is working](doc/example2.png) + ## Full Parameter Reference ``` JavaScript { diff --git a/doc/example.png b/doc/example.png index d56c193..0da91fa 100644 Binary files a/doc/example.png and b/doc/example.png differ diff --git a/doc/example2.png b/doc/example2.png new file mode 100644 index 0000000..faffc1e Binary files /dev/null and b/doc/example2.png differ