Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
fluentfuture authored Dec 3, 2023
1 parent 295ec29 commit a5008d1
Showing 1 changed file with 36 additions and 7 deletions.
43 changes: 36 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ A small Java 8 utilities library ([javadoc](http://google.github.io/mug/apidocs/
`String user = first('@').toEnd().removeFrom(email);`
* [StringFormat](https://github.com/google/mug/wiki/StringFormat-Explained) extracts structured data from string:
`new StringFormat("{yyyy}/{mm}/{dd}").parse(dateStr, (yyyy, mm, dd) -> ...)`
* [SafeQuery](https://github.com/google/mug/wiki/SafeQuery-Explained) and `GoogleSql` for injection-safe SQL templating.
* [Parallelizer](https://github.com/google/mug/wiki/Parallelizer-Explained) An _Executor-friendly_, _interruptible_ alternative to parallel streams.
* Graph utilities ([Walker](https://google.github.io/mug/apidocs/com/google/mu/util/graph/Walker.html), [ShortestPath](https://google.github.io/mug/apidocs/com/google/mu/util/graph/ShortestPath.html))
* [Google Protobuf Java 8 Utilities](https://google.github.io/mug/mug-protobuf/apidocs)
Expand All @@ -23,35 +24,63 @@ Add the following to pom.xml:
<dependency>
<groupId>com.google.mug</groupId>
<artifactId>mug</artifactId>
<version>6.6</version>
<version>7.0</version>
</dependency>
```

Add `mug-errorprone` to your annotationProcessorPaths:

```
<build>
<pluginManagement>
<plugins>
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<annotationProcessorPaths>
<path>
<groupId>com.google.errorprone</groupId>
<artifactId>error_prone_core</artifactId>
<version>2.23.0</version>
</path>
<path>
<groupId>com.google.mug</groupId>
<artifactId>mug-errorprone</artifactId>
<version>7.0</version>
</path>
</annotationProcessorPaths>
</configuration>
</plugin>
</plugins>
</pluginManagement>
</build>
```

Protobuf utils:
```
<dependency>
<groupId>com.google.mug</groupId>
<artifactId>mug-protobuf</artifactId>
<version>6.6</version>
<version>7.0</version>
</dependency>
```

Guava add-ons:
Guava add-ons (with `SafeQuery` and `GoogleSql`):
```
<dependency>
<groupId>com.google.mug</groupId>
<artifactId>mug-guava</artifactId>
<version>6.6</version>
<version>7.0</version>
</dependency>
```

### Gradle

Add to build.gradle:
```
implementation 'com.google.mug:mug:6.6'
implementation 'com.google.mug:mug-guava:6.6'
implementation 'com.google.mug:mug-protobuf:6.6'
implementation 'com.google.mug:mug:7.0'
implementation 'com.google.mug:mug-guava:7.0'
implementation 'com.google.mug:mug-protobuf:7.0'
```


Expand Down

0 comments on commit a5008d1

Please sign in to comment.