Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 41 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,14 @@

<PLACEHOLDER_DESCRIPTION>


---

## 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)
Expand Down Expand Up @@ -42,39 +41,41 @@ Make sure you have the following installed:
#### Using Maven

1. Add the following repository to the `<repositories>` block in your `pom.xml` file:
```xml
<repository>
<id>akazukin-repo</id>
<name>Akazukin Repository</name>
<url>https://maven.akazukin.org/refer/maven-<PLACEHOLDER_MAVEN>/</url>
</repository>
```

```xml
<repository>
<id>akazukin-repo</id>
<name>Akazukin Repository</name>
<url>https://maven.akazukin.org/refer/maven-<PLACEHOLDER_MAVEN>/</url>
</repository>
```

2. Add the dependency to the `<dependencies>` block in your `pom.xml` file:
```xml
<dependency>
<groupId>org.akazukin</groupId>
<artifactId><PLACEHOLDER_ARTIFACT></artifactId>
<version>VERSION</version>
</dependency>
```
```xml
<dependency>
<groupId>org.akazukin</groupId>
<artifactId><PLACEHOLDER_ARTIFACT></artifactId>
<version>VERSION</version>
</dependency>
```

---

#### 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-<PLACEHOLDER_MAVEN>/'
}
```

```groovy
maven {
name = 'Akazukin Repository'
url = 'https://maven.akazukin.org/refer/maven-<PLACEHOLDER_MAVEN>/'
}
```

2. Add the dependency to the `dependencies` block in your `build.gradle` file:
```groovy
implementation 'org.akazukin:<PLACEHOLDER_ARTIFACT>:<VERSION>'
```
```groovy
implementation 'org.akazukin:<PLACEHOLDER_ARTIFACT>:<VERSION>'
```

---

Expand All @@ -83,52 +84,50 @@ 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

To build the project from source, follow these steps:

1. Clone the repository:
```shell
git clone https://github.com/Akazukin-Team/<PLACEHOLDER_REPO>.git
cd <PLACEHOLDER_REPO>
```

```shell
git clone https://github.com/Akazukin-Team/<PLACEHOLDER_REPO>.git
cd <PLACEHOLDER_REPO>
```

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.

---

## License

This project is licensed under the terms described in the [License](LICENSE) file.


---

## Contact

If you need further assistance or wish to contact us directly,
please refer to the [Support](./.github/SUPPORT.md) page.


---
Loading