From 76008033004af2b9e0de7236e6631bd5665e3c0b Mon Sep 17 00:00:00 2001
From: Rhys B <jetpackingwolf@gmail.com>
Date: Sun, 1 Dec 2024 16:27:45 +1000
Subject: [PATCH] Update readme.md and GitHub action

---
 .github/workflows/build-and-test.yaml |  2 +-
 README.md                             | 47 +++++++++++++++++++++++++--
 2 files changed, 46 insertions(+), 3 deletions(-)

diff --git a/.github/workflows/build-and-test.yaml b/.github/workflows/build-and-test.yaml
index 95f9a3e..2047703 100644
--- a/.github/workflows/build-and-test.yaml
+++ b/.github/workflows/build-and-test.yaml
@@ -37,5 +37,5 @@ jobs:
       - name: Upload artifact
         uses: actions/upload-artifact@v3
         with:
-          name: ${{ github.ref_name }}-artifact
+          name: ${{ github.event.repository.name }}-artifact
           path: target/*.jar
\ No newline at end of file
diff --git a/README.md b/README.md
index cbe0319..d2b175d 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,45 @@
-# B1.7.3-Poseidon-Plugin-Template
-This repository is a Maven template for B1.7.3 plugins for RetroMC
+# Poseidon-Plugin-Template
+
+This repository serves as a template to assist with creating plugins for Project Poseidon.
+
+It includes examples of:
+- A configuration file.
+- A listener.
+- A command.
+
+## Steps to Use This Template
+
+1. **Clone the Repository**
+    - Clone this repository to your local machine.
+
+2. **Modify `pom.xml`**
+    - Update the following fields to reflect your plugin:
+        - `name`
+        - `version`
+        - `description`
+    - **Note:** Removing `-SNAPSHOT` from the version will trigger the `release.yml` GitHub Action to create a GitHub release.
+
+3. **Refactor Package Structure**
+    - Refactor the package `org.retromc.templateplugin` to a unique package name for your plugin to avoid conflicts.
+
+4. **Update `plugin.yml`**
+    - Update the `plugin.yml` file to match the refactored package name and plugin metadata.
+
+5. **Modify the Code**
+    - Customize the code as required for your plugin.
+    - **Important:**
+        - Remove the player greeting example in the listener.
+        - Remove the test command.
+
+## GitHub Actions
+
+This repository includes a pre-configured GitHub Action:
+
+1. **`build-and-test.yml`**:
+    - Runs tests on every push to ensure code quality.
+    - Uploads an artifact for each commit, allowing others to download the plugin for testing.
+
+2. **`release.yml`**:
+    - Automatically creates a GitHub release if the `-SNAPSHOT` suffix is removed from the version in `pom.xml`.
+
+With this template, you can kickstart your plugin development for Project Poseidon quickly and efficiently.