Skip to content

Commit 0522b3c

Browse files
nelihdevnelihdev
committed
rework docs
1 parent 877f7a0 commit 0522b3c

File tree

5 files changed

+90
-90
lines changed

5 files changed

+90
-90
lines changed

‎.github/workflows/build-and-release.yml‎

Lines changed: 78 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -1,74 +1,3 @@
1-
- [API Documentation](https://github.com/${{ github.repository }}/blob/main/API_DOCUMENTATION.md)
2-
- [Quick Start Guide](https://github.com/${{ github.repository }}/blob/main/QUICK_START.md)
3-
4-
### ✨ Features
5-
- ✅ Shared MongoDB connection pool
6-
- ✅ High-performance caching (80-95% hit rate)
7-
- ✅ Thread-safe async operations
8-
- ✅ REST API support
9-
- ✅ Works on Paper/Spigot and BungeeCord
10-
draft: false
11-
prerelease: false
12-
13-
- name: Upload Paper Release Asset
14-
uses: actions/upload-release-asset@v1
15-
env:
16-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
17-
with:
18-
upload_url: ${{ steps.create_release.outputs.upload_url }}
19-
asset_path: ./networkdataapi-paper/target/NetworkDataAPI-Paper-1.0-SNAPSHOT.jar
20-
asset_name: NetworkDataAPI-Paper-${{ steps.get_version.outputs.VERSION }}.jar
21-
asset_content_type: application/java-archive
22-
23-
- name: Upload Bungee Release Asset
24-
uses: actions/upload-release-asset@v1
25-
env:
26-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
27-
with:
28-
upload_url: ${{ steps.create_release.outputs.upload_url }}
29-
asset_path: ./networkdataapi-bungee/target/NetworkDataAPI-Bungee-1.0-SNAPSHOT.jar
30-
asset_name: NetworkDataAPI-Bungee-${{ steps.get_version.outputs.VERSION }}.jar
31-
asset_content_type: application/java-archive
32-
33-
auto-release:
34-
needs: build
35-
runs-on: ubuntu-latest
36-
if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master')
37-
38-
steps:
39-
- name: Checkout code
40-
uses: actions/checkout@v4
41-
with:
42-
fetch-depth: 0
43-
44-
- name: Set up JDK 17
45-
uses: actions/setup-java@v4
46-
with:
47-
java-version: '17'
48-
distribution: 'temurin'
49-
cache: maven
50-
51-
- name: Build with Maven
52-
run: mvn clean package -DskipTests
53-
54-
- name: Get current date
55-
id: date
56-
run: echo "DATE=$(date +'%Y.%m.%d')" >> $GITHUB_OUTPUT
57-
58-
- name: Get commit count
59-
id: commit_count
60-
run: echo "COUNT=$(git rev-list --count HEAD)" >> $GITHUB_OUTPUT
61-
62-
- name: Create automatic release
63-
uses: marvinpinto/action-automatic-releases@latest
64-
with:
65-
repo_token: ${{ secrets.GITHUB_TOKEN }}
66-
automatic_release_tag: "latest"
67-
prerelease: true
68-
title: "Development Build (${{ steps.date.outputs.DATE }}-${{ steps.commit_count.outputs.COUNT }})"
69-
files: |
70-
networkdataapi-paper/target/NetworkDataAPI-Paper-*.jar
71-
networkdataapi-bungee/target/NetworkDataAPI-Bungee-*.jar
721
name: Build and Release
732

743
on:
@@ -91,10 +20,10 @@ jobs:
9120
- name: Checkout code
9221
uses: actions/checkout@v4
9322

94-
- name: Set up JDK 17
23+
- name: Set up JDK 21
9524
uses: actions/setup-java@v4
9625
with:
97-
java-version: '17'
26+
java-version: '21'
9827
distribution: 'temurin'
9928
cache: maven
10029

@@ -126,10 +55,10 @@ jobs:
12655
- name: Checkout code
12756
uses: actions/checkout@v4
12857

129-
- name: Set up JDK 17
58+
- name: Set up JDK 21
13059
uses: actions/setup-java@v4
13160
with:
132-
java-version: '17'
61+
java-version: '21'
13362
distribution: 'temurin'
13463
cache: maven
13564

@@ -150,16 +79,87 @@ jobs:
15079
release_name: Release ${{ steps.get_version.outputs.VERSION }}
15180
body: |
15281
## NetworkDataAPI ${{ steps.get_version.outputs.VERSION }}
153-
82+
15483
### 📦 Downloads
15584
- **Paper/Spigot**: NetworkDataAPI-Paper-${{ steps.get_version.outputs.VERSION }}.jar
15685
- **BungeeCord**: NetworkDataAPI-Bungee-${{ steps.get_version.outputs.VERSION }}.jar
157-
86+
15887
### 🚀 Installation
15988
1. Download the appropriate JAR for your server type
16089
2. Place in `plugins/` folder
16190
3. Configure MongoDB in `plugins/NetworkDataAPI/config.yml`
16291
4. Restart server
163-
92+
16493
### 📚 Documentation
94+
- [API Documentation](https://github.com/${{ github.repository }}/blob/main/API_DOCUMENTATION.md)
95+
- [Quick Start Guide](https://github.com/${{ github.repository }}/blob/main/QUICK_START.md)
96+
97+
### ✨ Features
98+
- ✅ Shared MongoDB connection pool
99+
- ✅ High-performance caching (80-95% hit rate)
100+
- ✅ Thread-safe async operations
101+
- ✅ REST API support
102+
- ✅ Works on Paper/Spigot and BungeeCord
103+
draft: false
104+
prerelease: false
105+
106+
- name: Upload Paper Release Asset
107+
uses: actions/upload-release-asset@v1
108+
env:
109+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
110+
with:
111+
upload_url: ${{ steps.create_release.outputs.upload_url }}
112+
asset_path: ./networkdataapi-paper/target/NetworkDataAPI-Paper-1.0-SNAPSHOT.jar
113+
asset_name: NetworkDataAPI-Paper-${{ steps.get_version.outputs.VERSION }}.jar
114+
asset_content_type: application/java-archive
115+
116+
- name: Upload Bungee Release Asset
117+
uses: actions/upload-release-asset@v1
118+
env:
119+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
120+
with:
121+
upload_url: ${{ steps.create_release.outputs.upload_url }}
122+
asset_path: ./networkdataapi-bungee/target/NetworkDataAPI-Bungee-1.0-SNAPSHOT.jar
123+
asset_name: NetworkDataAPI-Bungee-${{ steps.get_version.outputs.VERSION }}.jar
124+
asset_content_type: application/java-archive
125+
126+
auto-release:
127+
needs: build
128+
runs-on: ubuntu-latest
129+
if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master')
130+
131+
steps:
132+
- name: Checkout code
133+
uses: actions/checkout@v4
134+
with:
135+
fetch-depth: 0
136+
137+
- name: Set up JDK 21
138+
uses: actions/setup-java@v4
139+
with:
140+
java-version: '21'
141+
distribution: 'temurin'
142+
cache: maven
143+
144+
- name: Build with Maven
145+
run: mvn clean package -DskipTests
146+
147+
- name: Get current date
148+
id: date
149+
run: echo "DATE=$(date +'%Y.%m.%d')" >> $GITHUB_OUTPUT
150+
151+
- name: Get commit count
152+
id: commit_count
153+
run: echo "COUNT=$(git rev-list --count HEAD)" >> $GITHUB_OUTPUT
154+
155+
- name: Create automatic release
156+
uses: marvinpinto/action-automatic-releases@latest
157+
with:
158+
repo_token: ${{ secrets.GITHUB_TOKEN }}
159+
automatic_release_tag: "latest"
160+
prerelease: true
161+
title: "Development Build (${{ steps.date.outputs.DATE }}-${{ steps.commit_count.outputs.COUNT }})"
162+
files: |
163+
networkdataapi-paper/target/NetworkDataAPI-Paper-*.jar
164+
networkdataapi-bungee/target/NetworkDataAPI-Bungee-*.jar
165165

‎.github/workflows/codeql-analysis.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ jobs:
3131
with:
3232
languages: ${{ matrix.language }}
3333

34-
- name: Set up JDK 17
34+
- name: Set up JDK 21
3535
uses: actions/setup-java@v4
3636
with:
37-
java-version: '17'
37+
java-version: '21'
3838
distribution: 'temurin'
3939
cache: maven
4040

‎.github/workflows/maven-ci.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ jobs:
1414
strategy:
1515
matrix:
1616
os: [ubuntu-latest, windows-latest]
17-
java: [17, 21]
17+
java: [21]
1818

1919
steps:
2020
- name: Checkout repository
@@ -47,7 +47,7 @@ jobs:
4747
continue-on-error: true
4848

4949
- name: Archive build artifacts
50-
if: matrix.os == 'ubuntu-latest' && matrix.java == '17'
50+
if: matrix.os == 'ubuntu-latest' && matrix.java == '21'
5151
uses: actions/upload-artifact@v4
5252
with:
5353
name: jars-java-${{ matrix.java }}

‎.github/workflows/publish-maven.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ jobs:
1414
- name: Checkout code
1515
uses: actions/checkout@v4
1616

17-
- name: Set up JDK 17
17+
- name: Set up JDK 21
1818
uses: actions/setup-java@v4
1919
with:
20-
java-version: '17'
20+
java-version: '21'
2121
distribution: 'temurin'
2222
cache: maven
2323

‎README.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -120,12 +120,12 @@ Add the NetworkDataAPI Core library to your plugin's dependencies:
120120
</repositories>
121121

122122
<dependencies>
123-
<dependency>
124-
<groupId>com.astroid.stijnjakobs</groupId>
125-
<artifactId>networkdataapi-core</artifactId>
126-
<version>1.0-SNAPSHOT</version>
127-
<scope>provided</scope>
128-
</dependency>
123+
<dependency>
124+
<groupId>com.astroid.stijnjakobs</groupId>
125+
<artifactId>networkdataapi-core</artifactId>
126+
<version>1.0-SNAPSHOT</version>
127+
<scope>provided</scope>
128+
</dependency>
129129
</dependencies>
130130
```
131131

0 commit comments

Comments
 (0)