diff --git a/README.md b/README.md index d559537..fc12b38 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,32 @@ # Ledger Databases -Adds support for MySQL and H2 databases in Ledger \ No newline at end of file +Adds support for MySQL and H2 databases in Ledger + +## Use + +## Common + +For both MySQL and H2, you will need to place Ledger Databases in your mods folder along with Ledger 1.1.0 or newer + +## H2 + +Add the following to the bottom of your Ledger config file: + +```toml +[database_extensions] +h2 = true +``` + +## MySQL + +Add the following to the bottom of your Ledger config file: + +```toml +[database_extensions] +mysql = true +url = "" +username = "" +password = "" +``` + +`url`: Must be URL of database with `/` appended. An example URL would be `localhost/ledger`. You can optionally add port information such as `localhost:3000/ledger` diff --git a/src/main/resources/fabric.mod.json b/src/main/resources/fabric.mod.json index 27e7b1a..7671bec 100644 --- a/src/main/resources/fabric.mod.json +++ b/src/main/resources/fabric.mod.json @@ -29,7 +29,7 @@ "fabric": "*", "minecraft": "1.17.x", "java": ">=16", - "ledger": "*", + "ledger": ">=1.1.0", "fabric-language-kotlin": "*" } }