Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
OroArmor authored Dec 2, 2020
1 parent ff7d9a7 commit 1ab0490
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ dependencies {
```

## How to use
The best way to use my config is to extend `com.oroarmor.config.Config` with your own class. Inside this class, you should include other classes that extend `com.oroarmor.config.ConfigItemGroup` for your config groups. See the [example](https://github.com/OroArmor/oro-config/tree/master/README.md#example) for a way to use the library.
The best way to use my config is to extend `com.oroarmor.config.Config` with your own class. Inside this class, you should include other classes that extend `com.oroarmor.config.ConfigItemGroup` for your config groups. See the [example](#example) for a way to use the library.

### Config Item
`ConfigItem`s are the main storage of the different values that make up your config. Currently the only supported types are `String`, `Double`, `Integer`, and `Boolean` (Technically `ConfigItemGroup`s, but those are extremely different). There are two constructors for `ConfigItem`:
Expand Down Expand Up @@ -69,7 +69,7 @@ Id is for the ID of the config which is used in commands and modmenu.
`ModMenuConfigScreen` is an abstract class that requires you to extend it, passing in your config into a super constructor. Because this is used as an entry point, your constructor ***must*** have no parameters.

### Example:
These are pulled from the testmod, and are part of this repositiory. [Test Mod](https://github.com/OroArmor/oro-config/tree/master/src/main/java/testmod)
These are pulled from the testmod, and are part of this repositiory. [Test Mod](https://github.com/OroArmor/oro-config/tree/master/src/testmod)

Config Class:
```java
Expand Down

0 comments on commit 1ab0490

Please sign in to comment.