Skip to content

Commit 0e29ac4

Browse files
committed
docs: fix readme
1 parent dfab47a commit 0e29ac4

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Check out an online demo https://status.harry.id
6464
type: http
6565
host: https://github.com
6666
url: https://github.com # (optional: URL review/clickable)
67-
ssc: True # (optional if the server uses a self-signed certificate)
67+
ssc: True # (optional: if the server uses a self-signed certificate)
6868
expected_code: 200
6969

7070
- name: Google DNS
@@ -75,11 +75,11 @@ Check out an online demo https://status.harry.id
7575
type: port
7676
host: db.example.com
7777
port: 5432
78-
```
78+
```
7979
80-
4. (Optional) Customize the `incidents.md` file to add any known incidents or maintenance schedules.
80+
3. (Optional) Customize the `incidents.md` file to add any known incidents or maintenance schedules.
8181

82-
5. (Optional) Modify the `index.html.theme` and `history.html.theme` files to customize the look and feel of your status pages.
82+
4. (Optional) Modify the `index.html.theme` and `history.html.theme` files to customize the look and feel of your status pages.
8383

8484
## Usage
8585

@@ -88,7 +88,7 @@ Check out an online demo https://status.harry.id
8888
python tinystatus.py
8989
```
9090

91-
2. The script will generate two files:
91+
2. The script will generate three files:
9292
- `index.html`: The main status page
9393
- `history.html`: The status history page
9494
- `history.json`: The status history and timestamp data
@@ -100,7 +100,7 @@ Check out an online demo https://status.harry.id
100100
```
101101
- On Windows, you can use the Task Scheduler to run the script at startup.
102102

103-
4. Serve the generated HTML files using your preferred web server (e.g., Apache, Nginx, or a simple Python HTTP server for testing).
103+
4. Serve the generated HTML files using your preferred web server (e.g., Apache, NGINX, or a simple Python HTTP server for testing).
104104

105105
## Using Docker
106106

@@ -124,7 +124,7 @@ TinyStatus porting are available in:
124124

125125
## Contributing
126126

127-
Contributions are welcome! Please feel free to submit a Pull Request.
127+
[Contributions](https://github.com/harsxv/tinystatus/contribute) are, of course, most welcome!
128128

129129
## License
130130

0 commit comments

Comments
 (0)