Skip to content

Commit b45115e

Browse files
Fix typos and enhance README documentation (#975)
* Fix typos and enhance README documentation Corrected typos and improved clarity in README. * Update README.md revert to serverless to remove unnecessary terminology regression in the API document Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> --------- Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
1 parent 6d85561 commit b45115e

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ It is hosted as a single page application on firebase. The source code is in the
6464
## API
6565

6666
The API https://api.httpsms.com is built using [Fiber](https://gofiber.io/), Go and [CockroachDB](https://www.cockroachlabs.com/) for the database.
67-
It rus as a serverless application on Google Cloud Run. The API documentation can be found here https://api.httpsms.com/index.html
67+
It runs as a serverless application on Google Cloud Run. The API documentation can be found here https://api.httpsms.com/index.html
6868

6969
```go
7070
// Sending an SMS Message using Go
@@ -96,7 +96,7 @@ works best for you:
9696

9797
### End-to-end Encryption
9898

99-
You can encrypt your messages end-to-end ysubg the military grade [AES-256 encryption](https://en.wikipedia.org/wiki/Advanced_Encryption_Standard)
99+
You can encrypt your messages end-to-end using the military grade [AES-256 encryption](https://en.wikipedia.org/wiki/Advanced_Encryption_Standard)
100100
algorithm. Your encryption key is stored only on our mobile phone so the even the server won't have any way to view the
101101
content of your SMS messages which are sent and received on your Android phone.
102102

@@ -245,7 +245,7 @@ docker compose up --build
245245

246246
### 7. Create the System User
247247

248-
- The application uses the concept of a system user to process events async. You should manually create this user in `users` table in your database. Make sure you use the same `id` and `api_key` as the `EVENTS_QUEUE_USER_ID`, and `EVENTS_QUEUE_USER_API_KEY` in your `.env` file.
248+
- The application uses the concept of a system user to process events asynchronously. You should manually create this user in `users` table in your database. Make sure you use the same `id` and `api_key` as the `EVENTS_QUEUE_USER_ID`, and `EVENTS_QUEUE_USER_API_KEY` in your `.env` file.
249249

250250
```SQL
251251
INSERT INTO users (id, api_key, email ) VALUES ('your-system-user-id', 'your-system-api-key', 'system@domain.com');

0 commit comments

Comments
 (0)