Skip to content

Commit 886cc69

Browse files
committed
prepare for initial version
1 parent d11c3ea commit 886cc69

File tree

2 files changed

+86
-32
lines changed

2 files changed

+86
-32
lines changed

README.md

Lines changed: 60 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,39 @@ A Java client library for interacting with the DatabunkerPro API. DatabunkerPro
2727

2828
## Installation
2929

30-
Add the following dependency to your `pom.xml`:
30+
### From JitPack (Recommended)
31+
32+
Add the JitPack repository and dependency to your `pom.xml`:
33+
34+
```xml
35+
<repositories>
36+
<repository>
37+
<id>jitpack.io</id>
38+
<url>https://jitpack.io</url>
39+
</repository>
40+
</repositories>
41+
42+
<dependency>
43+
<groupId>com.github.securitybunker</groupId>
44+
<artifactId>databunkerpro-java</artifactId>
45+
<version>v1.0.0</version>
46+
</dependency>
47+
```
48+
49+
**Note**: Replace `v1.0.0` with your desired version tag (e.g., `v1.0.1`, `v2.0.0`, etc.)
50+
51+
### From Local Maven Repository
52+
53+
For development or internal use:
54+
55+
```bash
56+
# Clone and install locally
57+
git clone https://github.com/securitybunker/databunkerpro-java.git
58+
cd databunkerpro-java
59+
mvn clean install
60+
```
61+
62+
Then add the dependency to your `pom.xml`:
3163

3264
```xml
3365
<dependency>
@@ -108,6 +140,33 @@ To run the tests use the following command:
108140
mvn test
109141
```
110142

143+
## Deployment
144+
145+
This project uses **JitPack** for automatic deployment. JitPack automatically builds and publishes your GitHub repository as a Maven dependency.
146+
147+
### How to Release a New Version
148+
149+
1. **Create a Git tag** for your release:
150+
```bash
151+
git tag v1.0.0
152+
git push origin v1.0.0
153+
```
154+
155+
2. **JitPack automatically builds** and publishes the package
156+
157+
3. **Users can then install** using the version tag:
158+
```xml
159+
<dependency>
160+
<groupId>com.github.securitybunker</groupId>
161+
<artifactId>databunkerpro-java</artifactId>
162+
<version>v1.0.0</version>
163+
</dependency>
164+
```
165+
166+
### View Build Status
167+
168+
Check your build status at: https://jitpack.io/#securitybunker/databunkerpro-java
169+
111170
## Contributing
112171

113172
1. Fork the repository

pom.xml

Lines changed: 26 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,31 @@
5050
</dependency>
5151
</dependencies>
5252

53+
54+
55+
<scm>
56+
<connection>scm:git:git://github.com/securitybunker/databunkerpro-java.git</connection>
57+
<developerConnection>scm:git:ssh://github.com/securitybunker/databunkerpro-java.git</developerConnection>
58+
<url>https://github.com/securitybunker/databunkerpro-java</url>
59+
</scm>
60+
61+
<licenses>
62+
<license>
63+
<name>MIT License</name>
64+
<url>https://opensource.org/licenses/MIT</url>
65+
<distribution>repo</distribution>
66+
</license>
67+
</licenses>
68+
69+
<developers>
70+
<developer>
71+
<name>Databunket team</name>
72+
<email>[email protected]</email>
73+
<organization>Databunker.org</organization>
74+
<organizationUrl>https://databunker.org/</organizationUrl>
75+
</developer>
76+
</developers>
77+
5378
<build>
5479
<plugins>
5580
<plugin>
@@ -87,37 +112,7 @@
87112
</execution>
88113
</executions>
89114
</plugin>
115+
90116
</plugins>
91117
</build>
92-
93-
<distributionManagement>
94-
<repository>
95-
<id>github</id>
96-
<name>GitHub Packages</name>
97-
<url>https://maven.pkg.github.com/securitybunker/databunkerpro-java</url>
98-
</repository>
99-
</distributionManagement>
100-
101-
<scm>
102-
<connection>scm:git:git://github.com/securitybunker/databunkerpro-java.git</connection>
103-
<developerConnection>scm:git:ssh://github.com/securitybunker/databunkerpro-java.git</developerConnection>
104-
<url>https://github.com/securitybunker/databunkerpro-java</url>
105-
</scm>
106-
107-
<licenses>
108-
<license>
109-
<name>MIT License</name>
110-
<url>https://opensource.org/licenses/MIT</url>
111-
<distribution>repo</distribution>
112-
</license>
113-
</licenses>
114-
115-
<developers>
116-
<developer>
117-
<name>Databunket team</name>
118-
<email>[email protected]</email>
119-
<organization>Databunker.org</organization>
120-
<organizationUrl>https://databunker.org/</organizationUrl>
121-
</developer>
122-
</developers>
123118
</project>

0 commit comments

Comments
 (0)