Skip to content

Commit

Permalink
docs: README update(#14)
Browse files Browse the repository at this point in the history
* fix: update codecov badge and group id in README

* chore: add gpg plugin configuration
  • Loading branch information
akshaypatidar1999 authored Jul 29, 2021
1 parent db8ca9b commit 9820a87
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 14 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# The Reactive Aerospike Client

[![Continuous Integration](https://github.com/dream11/vertx-aerospike-client/actions/workflows/ci.yml/badge.svg)](https://github.com/dream11/vertx-aerospike-client/actions/workflows/ci.yml)
[![Code Coverage](https://codecov.io/gh/dream11/vertx-aerospike-client/branch/chore/master/graph/badge.svg)](https://codecov.io/gh/dream11/vertx-aerospike-client)
[![Code Coverage](https://codecov.io/gh/dream11/vertx-aerospike-client/branch/master/graph/badge.svg)](https://codecov.io/gh/dream11/vertx-aerospike-client)
![License](https://img.shields.io/badge/license-MIT-green.svg)

## Overview
Expand All @@ -15,16 +15,16 @@ Add the following dependency to the *dependencies* section of your build descrip
- Maven (in your `pom.xml`):
```xml
<dependency>
<groupId>io.vertx</groupId>
<groupId>io.d11</groupId>
<artifactId>vertx-aerospike-client</artifactId>
<version>x.y.x</version>
<version>LATEST</version>
</dependency>
```

- Gradle (in your `build.gradle` file):
```
dependencies {
compile 'io.vertx:vertx-aerospike-client:x.y.z'
compile 'io.d11:vertx-aerospike-client:x.y.z'
}
```

Expand Down
20 changes: 10 additions & 10 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# The Reactive Aerospike Client

[![Continuous Integration](https://github.com/dream11/vertx-aerospike-client/actions/workflows/ci.yml/badge.svg)](https://github.com/dream11/vertx-aerospike-client/actions/workflows/ci.yml)
[![Code Coverage](https://codecov.io/gh/dream11/vertx-aerospike-client/branch/chore/master/graph/badge.svg)](https://codecov.io/gh/dream11/vertx-aerospike-client)
[![Code Coverage](https://codecov.io/gh/dream11/vertx-aerospike-client/branch/master/graph/badge.svg)](https://codecov.io/gh/dream11/vertx-aerospike-client)
![License](https://img.shields.io/badge/license-MIT-green.svg)

## Overview
Expand All @@ -11,20 +11,20 @@ The Vert.x Aerospike client provides an asynchronous API to interact aerospike s
## Usage

Add the following dependency to the *dependencies* section of your build descriptor:

- Maven (in your `pom.xml`):
```xml
<dependency>
<groupId>io.vertx</groupId>
<artifactId>vertx-aerospike-client</artifactId>
<version>x.y.x</version>
</dependency>
<dependency>
<groupId>io.d11</groupId>
<artifactId>vertx-aerospike-client</artifactId>
<version>LATEST</version>
</dependency>
```

- Gradle (in your `build.gradle` file):
```
dependencies {
compile 'io.vertx:vertx-aerospike-client:x.y.z'
compile 'io.d11:vertx-aerospike-client:x.y.z'
}
```

Expand Down Expand Up @@ -78,9 +78,9 @@ To run the test suite:
mvn clean verify
```
The test suite runs a Docker container from image `aerospike/aerospike-server` using [TestContainers](https://www.testcontainers.org/)
by default.
by default.

To run the test suite on a container built from a different docker image:
```shell
mvn clean verify -Daerospike.image=<image>
```
```
6 changes: 6 additions & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -375,6 +375,12 @@
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
<version>${maven.gpg.plugin.version}</version>
<configuration>
<gpgArguments>
<arg>--pinentry-mode</arg>
<arg>loopback</arg>
</gpgArguments>
</configuration>
<executions>
<execution>
<id>sign-artifacts</id>
Expand Down

0 comments on commit 9820a87

Please sign in to comment.