Skip to content

Commit

Permalink
chore(readme): Update readme
Browse files Browse the repository at this point in the history
Signed-off-by: dark0dave <dark0dave@mykolab.com>
  • Loading branch information
dark0dave committed Oct 5, 2023
1 parent 839b313 commit 0be371a
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ repos:
rev: v4.4.0
hooks:
- id: check-added-large-files
exclude: (?x)^(docs)
- id: check-case-conflict
- id: check-merge-conflict
- id: detect-private-key
Expand All @@ -13,6 +14,7 @@ repos:
rev: 3.0.0
hooks:
- id: forbid-binary
exclude: (?x)^(docs)
- id: git-dirty

- repo: https://github.com/Lucas-C/pre-commit-hooks
Expand Down
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,20 @@
/ /\/\ \ (_) | (_| | | | | | \__ \ || (_| | | | __/ |
\/ \/\___/ \__,_| |_|_| |_|___/\__\__,_|_|_|\___|_|

Automatically install mods from a prepopulated weidu.log file.

## Demo
![](docs/mod_installer.mp4)

## Usage
```sh
Usage: mod_installer [OPTIONS] --log-file <LOG_FILE> \
--game-directory <GAME_DIRECTORY> \
--weidu-binary <WEIDU_BINARY> \
--mod-directories <MOD_DIRECTORIES>

Options:
--log-file <LOG_FILE> Full path to target log [env: LOG_FILE=]
--log-file <LOG_FILE> Full path to target log [env: LOG_FILE=]
-g, --game-directory <GAME_DIRECTORY> Full path to game directory [env: GAME_DIRECTORY=]
-w, --weidu-binary <WEIDU_BINARY> Full Path to weidu binary [env: WEIDU_BINARY=]
-m, --mod-directories <MOD_DIRECTORIES> Full Path to mod directories [env: MOD_DIRECTORIES=]
Expand Down
Binary file added docs/mod_installer.mp4
Binary file not shown.

0 comments on commit 0be371a

Please sign in to comment.