From af3649da369d74a73725c292afa6153a0f41126f Mon Sep 17 00:00:00 2001
From: Luminous-Coder <luminous.coder@gmail.com>
Date: Tue, 16 Aug 2022 12:25:47 +0800
Subject: [PATCH] docs: Update the readme and the changelog

---
 CHANGELOG.md                  |  4 ++--
 README.md                     | 43 +++++++++++++++++++++++++++++++----
 gradle.properties             |  2 +-
 src/main/resources/config.yml | 13 +++++++++++
 src/main/resources/plugin.yml |  2 +-
 5 files changed, 55 insertions(+), 9 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index f993b93..d14a600 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,8 +1,8 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
-## Unreleased
-Released on:
+## v1.1.0
+Released on: 2022-08-16
 ### Added
 - Direct message protection.
 - Message format configuration.
diff --git a/README.md b/README.md
index d41c671..3748d07 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,46 @@
-# Safe-Chat
+# Safe Chat
 
-No more reportable message and "unsafe" marks.
+Safe Chat is a Minecraft plugin that protects players' messages.
 
 ## Features
 
-All the messages in the server are protected, so you cannot report anyone.
+The messages will be protected so no one is able to report while enable the plugin.
+Because of the way this plugin uses, the game won't mark messages as unverified or unsafe, too.
 
 ![Screenshot](https://truth.bahamut.com.tw/s01/202208/2d76aca3213c8848910a35327962c83b.JPG?w=1000)
 
-And there's no any "unsafe" mark, too!
+## Configuration
 
-The direct messages (using command such as `/w`) are also protected now.
+It's able to configure the format of the messages.
+When the first time the plugin enabled, it'll automatically generate the configuration file,
+you may change it with the description below:
+
+The format may contain strings inside a pair of curly brackets that will be replaced.
+The table below shows the general ones.
+
+| Name             | Description                                  |
+|------------------|----------------------------------------------|
+| `_BLACK`         | Make the following text black.               |
+| `_DARK_BLUE`     | Make the following text dark blue.           |
+| `_DARK_GREEN`    | Make the following text dark green.          |
+| `_DARK_AQUA`     | Make the following text dark aqua.           |
+| `_DARK_RED`      | Make the following text dark red.            |
+| `_DARK_PURPLE`   | Make the following text dark purple.         |
+| `_GOLD`          | Make the following text gold.                |
+| `_GRAY`          | Make the following text gray.                |
+| `_DARK_GRAY`     | Make the following text dark gray.           |
+| `_BLUE`          | Make the following text blue.                |
+| `_GREEN`         | Make the following text green.               |
+| `_AQUA`          | Make the following text aqua.                |
+| `_RED`           | Make the following text red.                 |
+| `_LIGHT_PURPLE`  | Make the following text light purple.        |
+| `_YELLOW`        | Make the following text yellow.              |
+| `_WHITE`         | Make the following text white.               |
+| `_MAGIC`         | Make the following text "magic".             |
+| `_BOLD`          | Make the following text bold.                |
+| `_STRIKETHROUGH` | Make the following text strikethrough.       |
+| `_UNDERLINE`     | Make the following text underline.           |
+| `_ITALIC`        | Make the following text italic.              |
+| `_RESET`         | Set the following text to the default style. |
+
+You can find specific ones for every entry in the generated configuration file.
diff --git a/gradle.properties b/gradle.properties
index 181900b..77e97ff 100644
--- a/gradle.properties
+++ b/gradle.properties
@@ -1 +1 @@
-plugin_version = 1.0.0
+plugin_version = 1.1.0
diff --git a/src/main/resources/config.yml b/src/main/resources/config.yml
index c3b2e84..3075ad4 100644
--- a/src/main/resources/config.yml
+++ b/src/main/resources/config.yml
@@ -1,3 +1,16 @@
+# Control the chat format
+#
+# Format: {sender} - The message sender.
 global-message-format: '{_GRAY}<{sender}>{_WHITE} {message}'
+
+# Control the direct message format the sender see.
+#
+# Format {sender} - The message sender.
+#        {target} - The message receiver.
 direct-message-sender-format: '{_GRAY}<YOU -> {target}>{_WHITE} {message}'
+
+# Control the direct message format the receiver see.
+#
+# Format {sender} - The message sender.
+#        {target} - The message receiver.
 direct-message-target-format: '{_GRAY}<{sender} -> YOU>{_WHITE} {message}'
diff --git a/src/main/resources/plugin.yml b/src/main/resources/plugin.yml
index 42c1f08..9c60bbc 100644
--- a/src/main/resources/plugin.yml
+++ b/src/main/resources/plugin.yml
@@ -1,5 +1,5 @@
 name: SafeChat
-version: 1.0.0
+version: 1.1.0
 author: Luminous-Coder
 
 main: luminous.safechat.Main