Skip to content

Commit 3981f61

Browse files
committed
fix: enhance README formatting and clarify environment variable usage
1 parent 81a3c99 commit 3981f61

1 file changed

Lines changed: 20 additions & 26 deletions

File tree

README.md

Lines changed: 20 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -26,23 +26,23 @@ Pulse Bridge can be deployed in various ways to suit your needs:
2626
- Docker
2727
- Kubernetes
2828

29-
### Quick Install
29+
### Quick Install :zap:
3030

3131
Install the latest version with a single command:
3232

3333
```bash
3434
curl -fsSL https://raw.githubusercontent.com/wavezync/pulse-bridge/main/install.sh | bash
3535
```
3636

37-
### 💻 Run locally (Build from source)
37+
### Run locally (Build from source) :computer:
3838

3939
```bash
4040
git clone https://github.com/wavezync/pulse-bridge.git
4141
cd pulse-bridge
4242
go run .
4343
```
4444

45-
### 🐳 Deploy with Docker
45+
### Docker :whale:
4646

4747
```bash
4848
docker pull ghcr.io/wavezync/pulse-bridge:latest
@@ -51,7 +51,7 @@ docker run -d -p 8080:8080 ghcr.io/wavezync/pulse-bridge:latest
5151

5252
Update the [config.yml](https://github.com/wavezync/pulse-bridge/blob/main/config.yml) in the project root to add your services and databases. Then rebuild the binary or Docker image and run it.
5353

54-
### 🚢 Deploy with Kubernetes
54+
### Kubernetes :ship:
5555

5656
There are many ways to deploy Pulse Bridge on Kubernetes. Below is a simple example using a Deployment, Service, and ConfigMap.
5757

@@ -109,26 +109,23 @@ data:
109109
110110
### Environment Configuration
111111
112-
1. .env file:
112+
#### Environment Variables
113113
114-
A .env file is **optional** but can be configured:
114+
You can set environment variables to configure Pulse Bridge. These variables can be used to override the default configuration file or set the host and port.
115115
116-
```bash
117-
PULSE_BRIDGE_CONFIG=mycustomconfig.yml # Sets the custom configuration file path, defaults to config.yml
118-
HOST=0.0.0.0 # Defaults to 0.0.0.0
119-
PORT=8080 # Defaults to 8080
120-
```
116+
```bash
117+
PULSE_BRIDGE_CONFIG=mycustomconfig.yml # Sets the custom configuration file path, defaults to config.yml
118+
HOST=0.0.0.0 # Defaults to 0.0.0.0
119+
PORT=8080 # Defaults to 8080
120+
```
121121

122-
2. CLI arguments:
123-
124-
```bash
125-
pulse-bridge --config=mycustomconfig.yml --port=8080 --host=0.0.0.0
126-
```
127-
128-
> **Note:** CLI arguments take priority over `.env` file settings.
129-
CLI > .env
122+
#### CLI arguments
130123

124+
CLI arguments take priority over environment variables and can be used to override the configuration file or set the host and port.
131125

126+
```bash
127+
pulse-bridge --config=mycustomconfig.yml --port=8080 --host=0.0.0.0
128+
```
132129

133130
## Usage
134131

@@ -215,11 +212,10 @@ monitors:
215212
216213
### Monitoring
217214
218-
219215
You can check the status of your service from the pulse bridge API at the routes:
220216
221-
222217
#### /monitor/services
218+
223219
- List all monitored services
224220
225221
```json
@@ -253,7 +249,8 @@ You can check the status of your service from the pulse bridge API at the routes
253249
]
254250
```
255251

256-
#### /monitor/services/{monitor_name}
252+
#### /monitor/services/{monitor_name}
253+
257254
- Get details of a specific service
258255

259256
```json
@@ -272,11 +269,8 @@ You can check the status of your service from the pulse bridge API at the routes
272269
},
273270
```
274271

275-
## Contributing
272+
## Contributing :heart:
276273

277274
We welcome contributions! If you have ideas, bug fixes, or improvements, please open an issue or submit a pull request.
278275

279-
280-
281-
282276
Keep your systems transparent, your teams informed, and your users confident with Pulse Bridge – the heartbeat of your infrastructure. 🌊

0 commit comments

Comments
 (0)