diff --git a/README.md b/README.md index 062c4dd..8f8d200 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,14 @@ - --- ## Table of Contents - [Features](#features) - [Getting Started](#getting-started) - - [Prerequisites](#prerequisites) - - [Installation](#installation) + - [Prerequisites](#prerequisites) + - [Installation](#installation) - [Contributing](#contributing) - [Build Instructions](#build-instructions) - [Continuous Integration](#continuous-integration) @@ -42,39 +41,41 @@ Make sure you have the following installed: #### Using Maven 1. Add the following repository to the `` block in your `pom.xml` file: - ```xml - - akazukin-repo - Akazukin Repository - https://maven.akazukin.org/refer/maven-/ - - ``` + + ```xml + + akazukin-repo + Akazukin Repository + https://maven.akazukin.org/refer/maven-/ + + ``` 2. Add the dependency to the `` block in your `pom.xml` file: - ```xml - - org.akazukin - - VERSION - - ``` + ```xml + + org.akazukin + + VERSION + + ``` --- #### Using Gradle 1. Add the repository to the `repositories` block in your `build.gradle` file: - ```groovy - maven { - name = 'Akazukin Repository' - url = 'https://maven.akazukin.org/refer/maven-/' - } - ``` + + ```groovy + maven { + name = 'Akazukin Repository' + url = 'https://maven.akazukin.org/refer/maven-/' + } + ``` 2. Add the dependency to the `dependencies` block in your `build.gradle` file: - ```groovy - implementation 'org.akazukin::' - ``` + ```groovy + implementation 'org.akazukin::' + ``` --- @@ -83,7 +84,6 @@ Make sure you have the following installed: Please read the [Contribution Guide](./.github/CONTRIBUTING.md) carefully and follow the coding conventions and guidelines when making your changes. - --- ## Build Instructions @@ -91,30 +91,31 @@ guidelines when making your changes. To build the project from source, follow these steps: 1. Clone the repository: - ```shell - git clone https://github.com/Akazukin-Team/.git - cd - ``` + + ```shell + git clone https://github.com/Akazukin-Team/.git + cd + ``` 2. Build the project with Gradle: - ```shell - ./gradlew build - ``` - The compiled JAR file will be located in the `build/libs/` directory. + ```shell + ./gradlew build + ``` + + The compiled JAR file will be located in the `build/libs/` directory. 3. Publish to the local Maven repository using the `maven-publish` plugin: - ```shell - ./gradlew publishToMavenLocal - ``` + ```shell + ./gradlew publishToMavenLocal + ``` --- ## Continuous Integration This project uses GitHub Actions for Continuous Integration (CI). -Every push to the `main` branch automatically triggers the build and test workflow. - +Every push to the production or development branch automatically triggers the build and test workflow. --- @@ -122,7 +123,6 @@ Every push to the `main` branch automatically triggers the build and test workfl This project is licensed under the terms described in the [License](LICENSE) file. - --- ## Contact @@ -130,5 +130,4 @@ This project is licensed under the terms described in the [License](LICENSE) fil If you need further assistance or wish to contact us directly, please refer to the [Support](./.github/SUPPORT.md) page. - ---