diff --git a/README.md b/README.md index 294d3d2b..83c81541 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,8 @@ Live status: **🟨 Partial outage** - Built with Svelte and Sapper - Fetches data from this repository using the GitHub API +![Screenshot of status website](./assets/screenshot-status.png) + ## 📈 Status This section automatically updates every day and when the status of any website changes: @@ -41,6 +43,38 @@ This section automatically updates every day and when the status of any website 2. Update the [`.statusrc.yml`](./.statusrc.yml) file with your configuration 3. Optionally, add a Personal Access Token for commits +### Concepts + +#### Issues as incidents + +When the GitHub Actions workflow detects that one of your URLs is down, it automatically opens a GitHub issue ([example issue #15](https://github.com/koj-co/upptime/issues/15)). You can add incident reports to this issue by adding comments. When your site comes back up, the issue will be closed automatically as well. + + + + + + +
+ Screenshot of GitHub issue + + Screenshot of incident page +
+ +#### Commits for response time + +Four times per day, another workflow runs and records the response time of your websites. This data is commited to GitHub, so it's available in the commit history of each file. Then, the GitHub API may be used to graph the response time history of each endpoint and track when a site goes down. + + + + + + +
+ Screenshot of GitHub commits + + Screenshot of live status +
+ ### Configuration The [`.statusrc.yml`](./.statusrc.yml) file is used as the central configuration for Upptime, with this syntax: diff --git a/assets/screenshot-history.png b/assets/screenshot-history.png new file mode 100644 index 00000000..087f1fe9 Binary files /dev/null and b/assets/screenshot-history.png differ diff --git a/assets/screenshot-incident.png b/assets/screenshot-incident.png index 39295e82..257dae18 100644 Binary files a/assets/screenshot-incident.png and b/assets/screenshot-incident.png differ diff --git a/assets/screenshot-issue.png b/assets/screenshot-issue.png new file mode 100644 index 00000000..f2246d43 Binary files /dev/null and b/assets/screenshot-issue.png differ diff --git a/assets/screenshot-live-status.png b/assets/screenshot-live-status.png new file mode 100644 index 00000000..5079212c Binary files /dev/null and b/assets/screenshot-live-status.png differ