Skip to content

Commit

Permalink
Merge pull request #26 from mk868/switch-to-maven
Browse files Browse the repository at this point in the history
Removal of Ant in favor of Maven
  • Loading branch information
ianopolous authored Aug 22, 2024
2 parents bc7bfca + 6607a6a commit 11bcde4
Show file tree
Hide file tree
Showing 8 changed files with 7 additions and 38 deletions.
24 changes: 0 additions & 24 deletions .github/workflows/ant.yml

This file was deleted.

4 changes: 2 additions & 2 deletions .github/workflows/maven.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
distribution: temurin
java-version: 11
- name: Build with Maven
run: mvn compile
run: mvn -B test-compile
- name: Run tests with Maven
timeout-minutes: 10
run: mvn test
run: mvn -B test
17 changes: 5 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,20 @@ Simply clone this repo.

## Usage

```
```java
MultiAddress m = new MultiAddress("/ip4/127.0.0.1/tcp/1234");
```
or

```
```java
MultiAddress m = new MultiAddress("/ipfs/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSupNKC");
```

## Dependency
You can use this project by building the JAR file as specified below, or by using [JitPack](https://jitpack.io/#multiformats/java-multiaddr/) (also supporting Gradle, SBT, etc).

for Maven, you can add the follwing sections to your POM.XML:
```
```xml
<repositories>
<repository>
<id>jitpack.io</id>
Expand All @@ -45,22 +45,15 @@ for Maven, you can add the follwing sections to your POM.XML:

## Testing

### Ant
`ant test`

### Maven
`mvn test`

## Building

### Ant
`ant dist` will build a JAR file in the `./dist` suitable for manual inclusion in a project. Dependent libraries are included in `./dist/lib`.

### Maven
`mvn package` will build a JAR file with Maven dependency information.

## Releasing
The version number is specified in `build.xml` and `pom.xml` and must be changed in both places in order to be accurately reflected in the JAR file manifest. A git tag must be added in the format "vx.x.x" for JitPack to work.

The version number is specified in the `pom.xml` file and must be changed in order to be accurately reflected in the JAR file manifest. A git tag must be added in the format "vx.x.x" for JitPack to work.

## Maintainers

Expand Down
Binary file removed lib/cid.jar
Binary file not shown.
Binary file removed lib/hamcrest-2.2.jar
Binary file not shown.
Binary file removed lib/junit-4.13.2.jar
Binary file not shown.
Binary file removed lib/multibase.jar
Binary file not shown.
Binary file removed lib/multihash.jar
Binary file not shown.

0 comments on commit 11bcde4

Please sign in to comment.