Skip to content

Commit 1d4d38e

Browse files
authored
chore: update README (#64)
* chore: update README * remove WIP
1 parent 460aeab commit 1d4d38e

1 file changed

Lines changed: 8 additions & 5 deletions

File tree

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,18 @@ ModpackResolver
44
This project allows you to quickly visualize which versions of Minecraft to use for a given set of mods.
55
Select the mods you would like to use, and the tool will list Minecraft versions with the highest compatibility (= with the most mods available).
66

7+
8+
# Usage
9+
## Website
710
Use it at https://itrooz.github.io/ModpackResolver
11+
## CLI
12+
Download the artifact from the [nightly release](https://github.com/iTrooz/ModpackResolver/releases)
813

914
# Authors
1015
- Frontend: [ZeKap](https://github.com/ZeKap)
1116
- API calls & backend: [iTrooz](https://github.com/iTrooz)
1217

1318
# Development
14-
First, install dependencies with `bun i`
15-
To run the web app in development mode, go the right folder (`cd web`) and run using `bun run dev`
16-
17-
# WIP
18-
Project is in dev state, not stable nor finished yet
19+
- Clone project
20+
- Install dependencies with `bun i`
21+
- To run the web app in development mode, go the right folder (`cd web`) and run using `bun run dev`. You may specify to proxy/cache API requests through http://localhost:8080 by running `bun run opt:proxy bun run dev`

0 commit comments

Comments
 (0)