Skip to content

Commit 0ea0d69

Browse files
committed
docs: fix typos in readme
1 parent a302c67 commit 0ea0d69

1 file changed

Lines changed: 7 additions & 6 deletions

File tree

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,18 @@ Everyone can use this project to analyze newly created TLS certificates as they
1313
## Motivation
1414

1515
From the moment I first found out about the certificate transparency logs, I was absolutely amazed by the great software of [Calidog](https://github.com/CaliDog/), which made the transparency log easier accessible for everyone.
16-
Their software "Certstream" parses the log and provides it in an easy-to-use format: json.
16+
Their software "Certstream" parses the log and provides it in an easy-to-use format: JSON.
1717

1818
After creating my first application that utilized the certstream server, I found that the hosted (demo) version of the server wasn't as reliable as I thought it would be.
19-
I got disconnects and sometimes other errors. Eventually the provided server was still only thought to be **a demo**.
19+
I got disconnects and sometimes other errors. Eventually, the provided server was still only thought to be **a demo**.
2020

2121
I quickly thought about running my own instance of certstream. But I didn't want to install Elixir/Erlang on my server. Sure, I could have used Docker, but on second thought, I was really into the idea of creating an alternative server written in Go.
2222

2323
"Why Go?", you might ask. Because it is a great language that compiles to native binaries on all major architectures and OSes. All the cool kids are using it right now.
2424

2525
## Getting started
2626

27-
Setting up an instance of the certstream server is simple. You can either download and compile the code yourself, or use one of the [precompiled binaries](https://github.com/d-Rickyy-b/certstream-server-go/releases).
27+
Setting up an instance of the certstream server is straightforward. You can either download and compile the code yourself, or use one of the [precompiled binaries](https://github.com/d-Rickyy-b/certstream-server-go/releases).
2828

2929
### Docker
3030

@@ -33,7 +33,8 @@ You can use it by running this command:
3333

3434
`docker run -d -v /path/to/config.yaml:/app/config.yaml -p 8080:8080 0rickyy0/certstream-server-go`
3535

36-
> ⚠️ If you don't mount your own config file, the default config (config.sample.yaml) will be used. For more details, check out the [wiki](https://github.com/d-Rickyy-b/certstream-server-go/wiki/Configuration).
36+
> [!WARNING]
37+
> If you don't mount your own config file, the default config (config.sample.yaml) will be used. For more details, check out the [wiki](https://github.com/d-Rickyy-b/certstream-server-go/wiki/Configuration).
3738
3839
## Connecting
3940

@@ -56,7 +57,7 @@ Read more about ping/pong WebSocket messages in the [Mozilla Developer Docs](htt
5657

5758
### Performance
5859

59-
At idle (no clients connected), the server uses about **40 MB** of RAM, **14.5 Mbit/s** and **4-10% CPU** (Oracle Free Tier) on average while processing around **250-300 certificates per second**.
60+
At idle (no clients connected), the server uses about **40 MB** of RAM, **14.5 Mbit/s** and **410% CPU** (Oracle Free Tier) on average while processing around **250300 certificates per second**.
6061

6162
### Monitoring
6263

@@ -67,7 +68,7 @@ For an in-depth guide on how to do this, please refer to the [wiki](https://gith
6768

6869
### Example
6970

70-
To receive a live example for any of the endpoints, just send an HTTP GET request to the endpoints with `/example.json` appended to the endpoint.
71+
To receive a live example for any of the endpoints, send an HTTP GET request to the endpoints with `/example.json` appended to the endpoint.
7172
For example: `/full-stream/example.json`. This shows the lite format of a certificate update.
7273

7374
```json

0 commit comments

Comments
 (0)