Skip to content

Open-source status page, incident response and uptime monitoring

📝 fix formating

Thibault Le Ouaya12c1639ae9c
diff --git a/README.md b/README.md
index bb4517911..11d22cff8 100644
--- a/README.md
+++ b/README.md
@@ -68,7 +68,8 @@ with us or send us an email at [[email protected]](mailto:[email protected])
3. Set up your .env file
- From `apps/web` and `packages/db`, you will find .env.example. Create your own copy.
+ From `apps/web` and `packages/db`, you will find .env.example. Create your
+ own copy.
4. Follow the steps to run your sqlite database locally inside of
[README.md](https://github.com/openstatusHQ/openstatus/blob/main/packages/db/README.md)
@@ -83,11 +84,19 @@ with us or send us an email at [[email protected]](mailto:[email protected])
the result.
For [clerk](https://clerk.com), you will need to create a webhook endpoint. To
-access the link, you can use tunneling tools like [Tunnelmole](https://github.com/robbie-cahill/tunnelmole-client), an open source tunnelling tool or ngrok, a popular closed source tunnelling tool.
+access the link, you can use tunneling tools like
+[Tunnelmole](https://github.com/robbie-cahill/tunnelmole-client), an open source
+tunnelling tool or ngrok, a popular closed source tunnelling tool.
### Using Tunnelmole
-1. Install Tunnelmole with `curl -O https://install.tunnelmole.com/384HK/install && sudo bash install`. (On Windows, download [tmole.exe](https://tunnelmole.com/downloads/tmole.exe))
-2. Run `tmole 3000`. In the output, you'll see two URLs, one HTTP, and an HTTPS URL. It's best to use the HTTPS URL for privacy and security.
+
+1. Install Tunnelmole with
+ `curl -O https://install.tunnelmole.com/384HK/install && sudo bash install`.
+ (On Windows, download
+ [tmole.exe](https://tunnelmole.com/downloads/tmole.exe))
+2. Run `tmole 3000`. In the output, you'll see two URLs, one HTTP, and an HTTPS
+ URL. It's best to use the HTTPS URL for privacy and security.
+
```
➜ ~ tmole 3000
http://bvdo5f-ip-49-183-170-144.tunnelmole.net is forwarding to localhost:3000
@@ -97,8 +106,8 @@ https://bvdo5f-ip-49-183-170-144.tunnelmole.net is forwarding to localhost:3000
Append `/api/webhook/clerk` to the HTTPs URL.
### Using ngrok
-After login, append `/api/webhook/clerk` to
-the link you get after entering:
+
+After login, append `/api/webhook/clerk` to the link you get after entering:
```
$ ngrok http 3000
@@ -106,7 +115,6 @@ $ ngrok http 3000
### Videos
-
Videos to better understand the OpenStatus codebase:
- [The code behind OpenStatus and how it uses Turbopack](https://youtube.com/watch?v=PYfSJATE8v8).