Skip to content

Commit

Permalink
Fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Syriiin committed Apr 25, 2024
1 parent 1810e33 commit 34f81dd
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions docs/docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,12 @@ By default, the beatmap cache will be lost when the container is restarted, and

## How to run a calculation

You can use the `GET /api/calculator/calculation` endpoint to calculate the difficulty and performance of a score.
You can use the `GET /api/calculation` endpoint to calculate the difficulty and performance of a score.

For example, to calculate an SS on [xi - Blue Zenith [FOUR DIMENSIONS]](https://osu.ppy.sh/beatmapsets/292301#osu/658127):

```sh
curl "localhost:5000/api/calculator/calculation?BeatmapId=658127"
curl "localhost:5000/api/calculation?BeatmapId=658127"
```

```json
Expand All @@ -105,7 +105,7 @@ curl "localhost:5000/api/calculator/calculation?BeatmapId=658127"
With HDHR:

```sh
curl "localhost:5000/api/calculator/calculation?BeatmapId=658127&Mods=24"
curl "localhost:5000/api/calculation?BeatmapId=658127&Mods=24"
```

```json
Expand All @@ -129,7 +129,7 @@ curl "localhost:5000/api/calculator/calculation?BeatmapId=658127&Mods=24"
With [24 100s and 2 misses with a max combo of 2364](https://osu.ppy.sh/scores/453746931):

```sh
curl "localhost:5000/api/calculator/calculation?BeatmapId=658127&Mods=24&Oks=24&Misses=2&Combo=2364"
curl "localhost:5000/api/calculation?BeatmapId=658127&Mods=24&Oks=24&Misses=2&Combo=2364"
```

```json
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ docker run -p 5000:80 ghcr.io/syriiin/difficalcy-osu:latest
Call the API:

```sh
curl "localhost:5000/api/calculator/calculation?BeatmapId=658127"
curl "localhost:5000/api/calculation?BeatmapId=658127"
```

Get your lazer powered calculations:
Expand Down

0 comments on commit 34f81dd

Please sign in to comment.