Skip to content

Commit eb303be

Browse files
authored
Update README.md
1 parent 647a0a9 commit eb303be

File tree

1 file changed

+5
-9
lines changed

1 file changed

+5
-9
lines changed

README.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,6 @@ cached datafeed is returned
1111
as the response in `data`.
1212

1313
The API Documentation can be found in the [wiki](https://github.com/vatger/datafeed-cache/wiki).
14-
> [!IMPORTANT]
15-
> The wiki still contains the older typescript type syntax. Semantically, the result types are identical though.
16-
> To view the concrete implementation of the types used, visit [the datafeed type definitions](./src/vatsim/types.rs).
17-
1814

1915
If you wish to contribute and/or make changes, please check out our contribution guide [here](CONTRIBUTING.md).
2016

@@ -26,7 +22,7 @@ If you wish to contribute and/or make changes, please check out our contribution
2622

2723
## Prerequisites
2824

29-
- **Rust** (tested with version 1.85.1)
25+
- **Rust** (version 1.85.1+)
3026
- **Cargo**
3127
- **OpenSSL** (required by *reqwest*)
3228

@@ -39,14 +35,14 @@ $ git clone https://github.com/vatger/datafeed-cache.git
3935
$ cd datafeed-cache
4036
```
4137

42-
You can build the application using `cargo build` or run it directly using `cargo run`, which will include the
38+
You can build the application using `cargo build -p datafeed-cache-server` or run it directly using `cargo run -p datafeed-cache-server`, which will include the
4339
compilation steps.
4440

45-
You can also specify the type of release you would like to build (e.g. release) by specifying `cargo build --release`.
41+
You can also specify the type of release you would like to build (e.g. release) by specifying `cargo build --release -p datafeed-cache-server`.
4642

4743
### Using Docker
4844

49-
If you prefer to use Docker for production / development, you can use the provided `docker-compose.yml` file, or create
45+
If you prefer to use Docker for production / development, you can use the provided `datafeed-cache-server/docker-compose.yml` file, or create
5046
your own.
5147
This compose-file will build the image and deploy it locally exposing port `8007` on the host machine.
5248

@@ -58,4 +54,4 @@ To stop the deployed stack, run
5854

5955
```shell
6056
$ docker compose down
61-
```
57+
```

0 commit comments

Comments
 (0)