1
mirror of https://github.com/CarmJos/EasyConfiguration.git synced 2024-09-19 20:25:51 +00:00

docs(readme): listed all supported formats.

This commit is contained in:
Carm Jos 2023-12-24 05:02:59 +08:00
parent 505b86ec9c
commit b77e64e6e6
2 changed files with 35 additions and 10 deletions

View File

@ -1,4 +1,3 @@
README LANGUAGES [ [**English**](README.md) | [中文](README_CN.md) ] README LANGUAGES [ [**English**](README.md) | [中文](README_CN.md) ]
# EasyConfiguration # EasyConfiguration
@ -12,19 +11,23 @@ README LANGUAGES [ [**English**](README.md) | [中文](README_CN.md) ]
**Easy _(to make)_ Configurations!** **Easy _(to make)_ Configurations!**
A simple, easy-to-use and universal solution for managing configuration files. A simple, easy-to-use and universal solution for managing configuration files.
Enjoy the ease of use with customizable formats for loading, reading, and updating your configuration files. Enjoy the ease of use with customizable formats for loading, reading, and updating your configuration files.
## Features & Advantages ## Features & Advantages
- Class-based mechanism for initializing, loading, retrieving, and updating configuration files, ensuring convenience and efficiency. Supported [YAML](impl/yaml), [JSON](impl/json), [HOCON](impl/hocon) and [SQL](impl/sql) based configuration files
format.
- Class-based mechanism for initializing, loading, retrieving, and updating configuration files, ensuring convenience
and efficiency.
- Supports manual serialization and deserialization of complex configurations. - Supports manual serialization and deserialization of complex configurations.
- Offers multiple builder forms for rapid construction of `ConfigValue<?>` objects. - Offers multiple builder forms for rapid construction of `ConfigValue<?>` objects.
- Enables specification of configuration paths, comments, and more via annotations. - Enables specification of configuration paths, comments, and more via annotations.
## Development ## Development
For a detailed development guide, [CLICK HERE](.doc/README.md). For a detailed development guide, [CLICK HERE](.doc/README.md).
For the latest JavaDoc release, [CLICK HERE](https://CarmJos.github.io/EasyConfiguration). For the latest JavaDoc release, [CLICK HERE](https://CarmJos.github.io/EasyConfiguration).
@ -42,6 +45,7 @@ For more examples, see the [Development Guide](.doc/README.md).
<summary>Remote Repository Configuration</summary> <summary>Remote Repository Configuration</summary>
```xml ```xml
<project> <project>
<repositories> <repositories>
@ -51,7 +55,7 @@ For more examples, see the [Development Guide](.doc/README.md).
<name>Maven Central</name> <name>Maven Central</name>
<url>https://repo1.maven.org/maven2</url> <url>https://repo1.maven.org/maven2</url>
</repository> </repository>
<repository> <repository>
<!-- Using GitHub dependencies for real-time updates, configuration required (recommended). --> <!-- Using GitHub dependencies for real-time updates, configuration required (recommended). -->
<id>EasyConfiguration</id> <id>EasyConfiguration</id>
@ -69,6 +73,7 @@ For more examples, see the [Development Guide](.doc/README.md).
<summary>Generic Native Dependency</summary> <summary>Generic Native Dependency</summary>
```xml ```xml
<project> <project>
<dependencies> <dependencies>
<!-- Basic implementation part, requiring custom implementation of “Provider” and “Wrapper”. --> <!-- Basic implementation part, requiring custom implementation of “Provider” and “Wrapper”. -->
@ -111,10 +116,10 @@ repositories {
// Using Maven Central Repository for secure and stable updates, though synchronization might be needed. // Using Maven Central Repository for secure and stable updates, though synchronization might be needed.
mavenCentral() mavenCentral()
// Using GitHub dependencies for real-time updates, configuration required (recommended). // Using GitHub dependencies for real-time updates, configuration required (recommended).
maven { url 'https://maven.pkg.github.com/CarmJos/EasyConfiguration' } maven { url 'https://maven.pkg.github.com/CarmJos/EasyConfiguration' }
} }
``` ```
@ -156,11 +161,11 @@ If you appreciate this plugin, consider supporting me with a donation!
Thank you for supporting open-source projects! Thank you for supporting open-source projects!
Many thanks to Jetbrains for kindly providing a license for us to work on this and other open-source projects. Many thanks to Jetbrains for kindly providing a license for us to work on this and other open-source projects.
[![](https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.svg)](https://www.jetbrains.com/?from=https://github.com/ArtformGames/ResidenceList) [![](https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.svg)](https://www.jetbrains.com/?from=https://github.com/ArtformGames/ResidenceList)
## Open Source License ## Open Source License
This project's source code is licensed under the [GNU LESSER GENERAL PUBLIC LICENSE](https://www.gnu.org/licenses/lgpl-3.0.html). This project's source code is licensed under
the [GNU LESSER GENERAL PUBLIC LICENSE](https://www.gnu.org/licenses/lgpl-3.0.html).

View File

@ -23,6 +23,8 @@ README LANGUAGES [ [English](README.md) | [**中文**](README_CN.md) ]
## 特性 & 优势 ## 特性 & 优势
支持 [YAML](impl/yaml), [JSON](impl/json), [HOCON](impl/hocon) 和 [SQL](impl/sql) 等多种配置文件格式。
- 基于类的配置文件初始化、加载、获取与更新机制,方便快捷。 - 基于类的配置文件初始化、加载、获取与更新机制,方便快捷。
- 支持复杂配置的手动序列化、反序列化。 - 支持复杂配置的手动序列化、反序列化。
- 提供多种builder形式快速构建 `ConfigValue<?>` 对象。 - 提供多种builder形式快速构建 `ConfigValue<?>` 对象。
@ -107,6 +109,20 @@ README LANGUAGES [ [English](README.md) | [**中文**](README_CN.md) ]
<scope>compile</scope> <scope>compile</scope>
</dependency> </dependency>
<dependency>
<groupId>cc.carm.lib</groupId>
<artifactId>easyconfiguration-hocon</artifactId>
<version>[LATEST RELEASE]</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>cc.carm.lib</groupId>
<artifactId>easyconfiguration-sql</artifactId>
<version>[LATEST RELEASE]</version>
<scope>compile</scope>
</dependency>
</dependencies> </dependencies>
</project> </project>
``` ```
@ -150,6 +166,10 @@ dependencies {
//基于JSON文件的实现版本可用于全部Java环境。 //基于JSON文件的实现版本可用于全部Java环境。
//需要注意的是JSON不支持文件注释。 //需要注意的是JSON不支持文件注释。
api "cc.carm.lib:easyconfiguration-json:[LATEST RELEASE]" api "cc.carm.lib:easyconfiguration-json:[LATEST RELEASE]"
api "cc.carm.lib:easyconfiguration-hocon:[LATEST RELEASE]"
api "cc.carm.lib:easyconfiguration-sql:[LATEST RELEASE]"
} }
``` ```