Browse Source

Update README

Lortseam 4 years ago
parent
commit
e6e14ce4b4
1 changed files with 10 additions and 8 deletions
  1. 10 8
      README.md

+ 10 - 8
README.md

@@ -1,13 +1,14 @@
 # CompleteConfig
 # CompleteConfig
-CompleteConfig is a flexible, all-in-one configuration API for [Fabric](https://fabricmc.net/) mods.  
+CompleteConfig is a flexible, all-in-one configuration library for [Fabric](https://fabricmc.net/) mods.  
 It takes care of creating and observing config entries, displaying them as GUI, and saving and loading the config.
 It takes care of creating and observing config entries, displaying them as GUI, and saving and loading the config.
 
 
 ## Goals
 ## Goals
 The main goal of this library is to provide a comprehensive configuration system solution.  
 The main goal of this library is to provide a comprehensive configuration system solution.  
 This means:
 This means:
+* Easy integration into existing code
 * Great flexibility in API usage
 * Great flexibility in API usage
 * Full framework, no other libraries are required
 * Full framework, no other libraries are required
-* Easy integration into existing code
+* Works in both client and server environment
 
 
 ## Setup
 ## Setup
 [![](https://jitpack.io/v/com.gitlab.Lortseam/completeconfig.svg)](https://jitpack.io/#com.gitlab.Lortseam/completeconfig)
 [![](https://jitpack.io/v/com.gitlab.Lortseam/completeconfig.svg)](https://jitpack.io/#com.gitlab.Lortseam/completeconfig)
@@ -24,17 +25,18 @@ Then add CompleteConfig as dependency:
 dependencies {
 dependencies {
     ...
     ...
 
 
-    //This adds CompleteConfig and includes it in your mod's jar, so users don't have to install it
-    //Replace Tag with the current version you can find above
+    // This adds CompleteConfig and includes it in your mod's jar, so users don't have to install it
+    // Replace Tag with the current version you can find above
     modApi 'com.gitlab.Lortseam:completeconfig:Tag'
     modApi 'com.gitlab.Lortseam:completeconfig:Tag'
     include 'com.gitlab.Lortseam:completeconfig:Tag'
     include 'com.gitlab.Lortseam:completeconfig:Tag'
     
     
-    //This bundles Cloth Config in your mod's jar which is required for CompleteConfig
-    //Replace Version with current version
+    // This bundles Cloth Config in your mod's jar
+    // Only required if you want to display a GUI based on your mod's config and don't provide your own GUI generation
+    // Replace Version with the current version
     include 'me.shedaniel.cloth:config-2:Version'
     include 'me.shedaniel.cloth:config-2:Version'
 
 
-    //Recommended: Adds Mod Menu to your game, so you can easily open and check your config GUI (see the Mod Menu documentation for more information)
-    //Replace Version with current version
+    // Recommended: Adds Mod Menu to your game, so you can easily open and check your config GUI (see the Mod Menu documentation for more information)
+    // Replace Version with current version
     modImplementation 'io.github.prospector:modmenu:Version'
     modImplementation 'io.github.prospector:modmenu:Version'
 }
 }
 ```
 ```