Skip to content

Commit fa39c1e

Browse files
committed
update readme
1 parent 1699fb1 commit fa39c1e

1 file changed

Lines changed: 18 additions & 5 deletions

File tree

README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,23 +19,36 @@ and descriptions, which can be used to generate configuration files with comment
1919
- **🔧 Default Values**: Define default values for options that can be overridden.
2020
- **🔒 Type Safety**: Strongly typed configuration options for better safety and clarity.
2121
If the given value of a configuration option is invalid, it will use the default value instead.
22-
- **🌍 Localization API**: Simple and easy to use **enum-based** localization API to manage
22+
- **🌍 Localization**: Simple and easy to use **enum-based** localization library to manage
2323
internationalization. Enjoy **autocompletion** in your IDE and no more hassle with mistyped
2424
keys or missing translations.
2525
- See [Getting Started: Localization 🌍](#getting-started-localization-) for more details.
2626

2727
## Adding to your Project 📦
28-
To add Configured to your project, you can use Maven or Gradle.
28+
Configured is available on **Maven Central**, so you can easily add it to your project
29+
using Maven or Gradle.
30+
2931
Configured is divided into multiple modules:
30-
- `configured`: The core library that provides the main functionality.
31-
- `configured-localization`: The Localization API.
32+
- `configured-core`: The core configuration library.
33+
- `configured-localization`: The localization library built on top of Configured.
3234

3335
And each data format has its own module:
3436
- `configured-yaml`: The YAML data format module.
3537
- `configured-json`: The JSON data format module.
3638

37-
Make sure to include the modules you need in your project.
39+
Make sure to include the modules you need in your project:
40+
```kotlin
41+
repositories {
42+
mavenCentral()
43+
}
3844

45+
dependencies {
46+
implementation("de.clickism:configured-core:0.2") // Required
47+
implementation("de.clickism:configured-yaml:0.2")
48+
implementation("de.clickism:configured-json:0.2")
49+
implementation("de.clickism:configured-localization:0.2")
50+
}
51+
```
3952

4053
## Getting Started: Configuration 🛠️
4154

0 commit comments

Comments
 (0)