Skip to content
This repository has been archived by the owner on Sep 20, 2024. It is now read-only.

Commit

Permalink
fix readme.
Browse files Browse the repository at this point in the history
Signed-off-by: Yonle <[email protected]>
  • Loading branch information
Yonle committed Feb 19, 2024
1 parent c16028a commit d82eb09
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This project solve the problem by **reducing** the number of connected relays, a
- [NodeJS](https://nodejs.org) (v16 or up)
- A fast internet connection

#### Bostr CLI
### Bostr CLI
Install bostr via `npm`:
```
npm install -g bostr
Expand All @@ -37,7 +37,7 @@ bostr makeconf bostr_config.js

Edit `bostr_config.js` (Could be modified) with your file editor and fill some required fields accordingly to your needs. You could run it for everyone or only for yourself.

### Running
#### Running
After you finished editing the config file, You could start bostr with the following command:
```
bostr start bostr_config.js
Expand All @@ -51,7 +51,7 @@ tmux new -d "bostr start bostr_config.js"

When configuring reverse proxy, Ensure that `x-forwarded-proto` header was set as `https`.

#### Source code
### Source code

```
git clone -b stable https://github.com/Yonle/bostr
Expand All @@ -61,7 +61,7 @@ npm i

Rename `config.js.example` as `config.js`, Start editing the file and fill some required fields accordingly to your needs. You could run it for everyone or only for yourself.

### Running
#### Running
```
node index.js
```
Expand Down

0 comments on commit d82eb09

Please sign in to comment.