Skip to content

Commit 11fe909

Browse files
committed
Reformat README
1 parent 926c160 commit 11fe909

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,16 @@
22

33
A simple CRUD backend app using Actix-web, Diesel and JWT
44

5-
# Require
5+
## Require
66

77
- [Rust Stable](https://rustup.rs)
88
- [Postgres](https://www.postgresql.org/)
99

1010
Or using [Docker](https://www.docker.com/)
1111

12-
# How to run
12+
## How to run
13+
14+
### Manual
1315

1416
- Rename `secret.key.sample` to `secret.key` or create your own key by running `head -c16 /dev/urandom > secret.key` in command line (Linux/UNIX only) and copy to `/src` folder
1517
- Create a database in postgres cli or [pgAdmin](https://www.pgadmin.org/) tool
@@ -25,11 +27,11 @@ Or using [Docker](https://www.docker.com/)
2527
- Enter into project directory and run `docker-compose up`
2628
- Enjoy! 😄
2729

28-
# APIs
30+
## APIs
2931

30-
## Address: **`localhost:8080`**
32+
### Address: **`localhost:8080`**
3133

32-
### **`GET /api/ping`**: Ping
34+
### `GET /api/ping`: Ping
3335

3436
- Response:
3537
- 200 OK

0 commit comments

Comments
 (0)