Skip to content

Commit 1411e74

Browse files
committed
docs: update getting started instructions
1 parent d92019b commit 1411e74

1 file changed

Lines changed: 32 additions & 5 deletions

File tree

README.md

Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,23 +32,50 @@ Power.Trade API home page can be found [here](https://support.power.trade/api/ap
3232

3333
See [https://forge.rust-lang.org/infra/other-installation-methods.html](here) for other installation methods.
3434

35-
2. Check that Rustup has installed and configured **1.80** as the default version by typing the following command in a console/terminal window
35+
2. Check that Rustup has installed and configured **1.86** as the default version by typing the following command in a console/terminal window
3636
```
3737
rustc --version
3838
```
39-
the version displayed should be: "rustc 1.80.0 (default)"
39+
the version displayed should be: "rustc 1.86.0 (default)"
4040
3. Copy the sample env file (".env.example") to create a file for the Test environment
4141
```
4242
cp .env.example .env.test
4343
```
4444
4. Open the new `.env.test` file and update the settings for your Test API environment
45-
46-
5. Save the file and run the client on the Test environment(same process can be followed to create production env file '.env.prod')
45+
46+
Required environment variables include:
47+
48+
- `PT_API_KEY` - Power.Trade API key
49+
- `PT_WS_API_KEY` - WebSocket API key
50+
- `PT_WS_API_SECRET` - WebSocket API secret in PEM format
51+
- `PT_SERVER` - FIX server hostname
52+
- `PT_WS_SERVER` - WebSocket endpoint
53+
- `PT_PEM_FILE` - path to your client PEM file
54+
- `PT_PUBKEY_FILE` - path to your public certificate
55+
- `PT_SCENARIO` - scenario to run (`ORDER`, `ORDERS`, `RFQ_QUOTE`, `RFQ_LISTEN`)
56+
- `PT_LISTEN_EPOCH` - listen epoch value
57+
- `PT_PUBLISH_EPOCH` - publish epoch value
58+
- `PT_HEARTBEAT_COUNT` - number of heartbeats
59+
- `PT_HEARTBEAT_INTERVAL` - seconds between heartbeats
60+
61+
5. Build the project
62+
63+
```
64+
cargo build
65+
```
66+
67+
6. Run tests to ensure everything is configured correctly
68+
69+
```
70+
cargo test
71+
```
72+
73+
7. Save the file and run the client on the Test environment (same process can be followed to create production env file '.env.prod')
4774

4875
n.b. Rust client runtime environment is set on command line as a parameter for the --env flag with value of 'development', 'test', 'production'
4976
```
5077
cargo run -- --env test
5178
```
52-
6. Review console output and log files (see `app.log` in the same folder) to view client activity
79+
8. Review console output and log files (see `app.log` in the same folder) to view client activity
5380

5481

0 commit comments

Comments
 (0)