Skip to content

Commit 6f96435

Browse files
committed
fix: readme
1 parent b03fc5e commit 6f96435

File tree

2 files changed

+14
-6
lines changed

2 files changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# RUST API SERVER
22

3+
![Logo](./logo.png)
4+
5+
[![License](https://img.shields.io/github/license/sonntuet1997/rust-web-api-microservice-template)](https://github.com/sonntuet1997/rust-web-api-microservice-template/blob/master/LICENSE)
6+
[![Continuous Integration](https://github.com/sonntuet1997/rust-web-api-microservice-template/actions/workflows/ci.yaml/badge.svg)](https://github.com/sonntuet1997/rust-web-api-microservice-template/actions/workflows/ci.yaml)
7+
38
## Introduction
49

510
Welcome to the Rust API Server! This server provides a simple REST interface for your applications. This README will
@@ -35,14 +40,14 @@ Options:
3540
- Multiple config locations
3641

3742
```shell
38-
./cli -c ./config/* -c deploy/local/custom.toml
43+
./cli -c ./config/*.toml -c deploy/local/custom.toml
3944
```
4045

4146
- Pipe the output with [bunyan](https://github.com/trentm/node-bunyan)
4247

4348
```shell
4449
cargo install bunyan
45-
./cli -c ./config/* -c deploy/local/custom.toml | bunyan
50+
./cli -c ./config/*.toml -c deploy/local/custom.toml | bunyan
4651
```
4752

4853
## Configuration
@@ -51,6 +56,8 @@ cargo install bunyan
5156

5257
Configuration is applied in the following order: config files -> environment variables -> command-line arguments.
5358

59+
If you use `-c *.toml` to load config files, please be mindful of the order in which the files are applied.
60+
5461
### Environment Variable Examples
5562

5663
The server can be configured using environment variables. Below is a table outlining the available configuration
@@ -73,11 +80,11 @@ Make sure to set these environment variables according to your needs before runn
7380
## GitHub Flow CI Configuration
7481

7582
1. **Set Docker Hub Secrets:**
76-
- Go to repository Settings > Secrets.
77-
- Add `DOCKER_USERNAME` and `DOCKERHUB_TOKEN`.
83+
- Go to repository Settings > Secrets.
84+
- Add `DOCKER_USERNAME` and `DOCKERHUB_TOKEN`.
7885

7986
2. **Enable Dependabot Alerts:**
80-
- In repository Insights, enable "Dependabot alerts" and "Security & Analysis."
87+
- In repository Insights, enable "Dependabot alerts" and "Security & Analysis."
8188

8289
## Checklist
8390

@@ -116,7 +123,8 @@ Demonstrate proficiency in advanced development practices including:
116123
8. [ ] Comprehensive DB query filter for list().
117124
9. [ ] Optimize release binary performance.
118125
10. [ ] Docs on how to use this repo, the design behind the scene.
119-
Feel free to explore and expand upon these functionalities as needed for your project. Happy coding!
126+
127+
Feel free to explore and expand upon these functionalities as needed for your project. Happy coding!
120128

121129
## Load Testing and Profiling
122130

logo.png

190 KB
Loading

0 commit comments

Comments
 (0)