Skip to content

Commit

Permalink
Merge pull request #131 from 47degrees/auto-update-docs
Browse files Browse the repository at this point in the history
Update documentation and other files
  • Loading branch information
github-actions[bot] committed Feb 27, 2020
2 parents 5c74687 + 4aa63b0 commit 4ed2575
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,22 +55,22 @@ This library aims to solve the aforementioned issues and provide an RFC-complian
<dependency>
<groupId>com.47deg</groupId>
<artifactId>memeid</artifactId>
<version>0.0.0</version>
<version>0.0.1</version>
</dependency>
```

#### Using gradle

```groovy
compile group: 'com.47deg', name: 'memeid', version: '0.0.0'
compile group: 'com.47deg', name: 'memeid', version: '0.0.1'
```

### Scala

Add this to your `build.sbt` file:

```scala
libraryDependencies += "com.47deg" %% "memeid4s" % "0.0.0"
libraryDependencies += "com.47deg" %% "memeid4s" % "0.0.1"
```

## Usage
Expand Down Expand Up @@ -158,7 +158,7 @@ u.asJava


```scala
libraryDependencies += "com.47deg" %% "memeid4s-literal" % "0.0.0"
libraryDependencies += "com.47deg" %% "memeid4s-literal" % "0.0.1"
```

We can now create UUIDs with literal syntax by importing `memeid.literal._`
Expand Down Expand Up @@ -188,7 +188,7 @@ uuid"not-a-uuid"
The [Doobie](https://github.com/tpolecat/doobie) integration allows you to use the `UUID` type mapped to your database's UUID type.

```scala
libraryDependencies += "com.47deg" %% "memeid4s-doobie" % "0.0.0"
libraryDependencies += "com.47deg" %% "memeid4s-doobie" % "0.0.1"
```

To have the [UUID mappings](https://tpolecat.github.io/doobie/docs/12-Custom-Mappings.html) available in scope you can import `memeid.doobie.implicits`.
Expand Down Expand Up @@ -219,7 +219,7 @@ val example = uuid"58d61328-1b08-1171-1ee7-1283ed639e77"
##### Circe

```scala
libraryDependencies += "com.47deg" %% "memeid4s-circe" % "0.0.0"
libraryDependencies += "com.47deg" %% "memeid4s-circe" % "0.0.1"
```

You can import `memeid.circe.implicits` to have the `Encoder` and `Decoder` instances for `UUID` in scope.
Expand All @@ -243,7 +243,7 @@ Decoder[UUID].decodeJson(json)
##### Http4s

```scala
libraryDependencies += "com.47deg" %% "memeid4s-http4s" % "0.0.0"
libraryDependencies += "com.47deg" %% "memeid4s-http4s" % "0.0.1"
```

###### Path parameters
Expand Down Expand Up @@ -283,7 +283,7 @@ HttpRoutes.of[IO] {
##### Cats & Cats-effect

```scala
libraryDependencies += "com.47deg" %% "memeid4s-cats" % "0.0.0"
libraryDependencies += "com.47deg" %% "memeid4s-cats" % "0.0.1"
```

The cats integration provides typeclass implementation for `UUID`, as well as effectful constructors for UUIDs for integration with programs that use `cats-effect`.
Expand Down Expand Up @@ -311,7 +311,7 @@ UUID.v5[IO, String](namespace, "my-secret-code")
##### Scalacheck

```scala
libraryDependencies += "com.47deg" %% "memeid4s-scalacheck" % "0.0.0"
libraryDependencies += "com.47deg" %% "memeid4s-scalacheck" % "0.0.1"
```

The scalacheck integration provides `Arbitrary` instances for the `UUID`, as well as for the different version classes.
Expand Down

0 comments on commit 4ed2575

Please sign in to comment.