Skip to content

Commit

Permalink
release: v1.0.0 (#21)
Browse files Browse the repository at this point in the history
* docs(readme): preparing for deployment

* chore: version to v1.0.0
  • Loading branch information
junghoon-vans authored Jul 19, 2023
1 parent a403af7 commit cb58a32
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 29 deletions.
36 changes: 8 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
Testcontainers Meilisearch
===

[![Maven Central](https://img.shields.io/maven-central/v/io.vanslog/testcontainers-meilisearch.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22io.vanslog%22%20AND%20a:%22testcontainers-meilisearch%22)
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=testcontainers-meilisearch&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=testcontainers-meilisearch)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=testcontainers-meilisearch&metric=coverage)](https://sonarcloud.io/summary/new_code?id=testcontainers-meilisearch)
![](https://img.shields.io/github/license/junghoon-vans/testcontainers-meilisearch?label=License)
Expand All @@ -23,57 +24,36 @@ MeilisearchContainer container = new MeilisearchContainer();
### Custom image

```java
DockerImageName imageName = DockerImageName.parse("getmeili/meilisearch:latest");

@Container
MeilisearchContainer container = new MeilisearchContainer(imageName);
MeilisearchContainer container = new MeilisearchContainer(DockerImageName.parse("getmeili/meilisearch:latest"));
```

### Set master key
### Setup master key

```java
@Container
MeilisearchContainer container = new MeilisearchContainer()
.withMasterKey("masterKey");
```

Dependency
Setup
---

> **Note**
> This project is not available in `Maven Central` repository.
> So you need to add the `Sonatype Snapshots` repository to your build file.
This library is available in Maven Central.
You can add it as a dependency to your project using the following snippets.

### Gradle

```groovy
// build.gradle
repositories {
mavenCentral()
maven {
url 'https://s01.oss.sonatype.org/content/repositories/snapshots/'
}
}
testImplementation 'io.vanslog:testcontainers-meilisearch:1.0.0-SNAPSHOT'
testImplementation 'io.vanslog:testcontainers-meilisearch:1.0.0'
```

### Maven

```xml
<!-- pom.xml -->
<repositories>
<repository>
<id>sonatype-snapshots</id>
<name>Sonatype Snapshots</name>
<url>https://s01.oss.sonatype.org/content/repositories/snapshots/</url>
</repository>
</repositories>

<dependency>
<groupId>io.vanslog</groupId>
<artifactId>testcontainers-meilisearch</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>1.0.0</version>
<scope>test</scope>
</dependency>
```
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<groupId>io.vanslog</groupId>
<artifactId>testcontainers-meilisearch</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>1.0.0</version>

<name>testcontainers-meilisearch</name>
<description>Testcontainers Meilisearch</description>
Expand Down

0 comments on commit cb58a32

Please sign in to comment.