Skip to content

Commit c23a455

Browse files
committed
Docs
1 parent b69b03a commit c23a455

File tree

2 files changed

+25
-28
lines changed

2 files changed

+25
-28
lines changed

CHANGELOG.md

+15-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
1-
# 1.0.0
1+
# Changelog
22

3-
Initial release with a set of Java functional interfaces and Try
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## 1.0.1
9+
10+
### Added
11+
- Maven Central repository support
12+
13+
## 1.0.0
14+
15+
### Added
16+
- Initial release with a set of Java functional interfaces and Try

README.md

+10-26
Original file line numberDiff line numberDiff line change
@@ -8,39 +8,23 @@ This dependency-less library serves for one simple purpose - allow developer to
88

99
- Maven
1010
```xml
11-
<project>
12-
<repositories>
13-
<repository>
14-
<id>jcenter</id>
15-
<name>jcenter</name>
16-
<url>https://jcenter.bintray.com</url>
17-
</repository>
18-
</repositories>
19-
20-
<dependencies>
21-
<dependency>
22-
<groupId>com.github.suppie</groupId>
23-
<artifactId>java-throwable-utils</artifactId>
24-
<version>1.0.0</version>
25-
</dependency>
26-
</dependencies>
27-
</project>
11+
<dependency>
12+
<groupId>io.github.suppierk</groupId>
13+
<artifactId>java-throwable-utils</artifactId>
14+
<version>1.0.1</version>
15+
</dependency>
2816
```
2917

3018
- Gradle
3119
```groovy
32-
repositories {
33-
jcenter()
34-
}
35-
3620
dependencies {
37-
implementation 'com.github.suppie:java-throwable-utils:1.0.0'
21+
implementation 'io.github.suppierk:java-throwable-utils:1.0.1'
3822
}
3923
```
4024

4125
## Examples
4226

43-
If previously you had to use constructs like:
27+
If you had to use constructs like:
4428

4529
```java
4630
import java.util.ArrayList;
@@ -65,7 +49,7 @@ public class Test {
6549
}
6650
```
6751

68-
with this library you can simplify this pipeline to:
52+
with this library, you can simplify this pipeline to:
6953

7054
```java
7155
import function.io.github.suppierk.java.util.ThrowableConsumer;
@@ -86,7 +70,7 @@ public class Test {
8670
}
8771
```
8872

89-
All exceptions will be propagated as is using neat trick similar to Apache Commons `ExceptionUtils.rethrow` by leveraging Java' type erasure to make checked exceptions unchecked.
73+
All exceptions will be propagated using neat trick similar to Apache Commons `ExceptionUtils.rethrow` by leveraging Java type erasure to make checked exceptions unchecked.
9074

9175
## Try
9276

@@ -115,7 +99,7 @@ public class Test {
11599
}
116100
```
117101

118-
Same as for `Optional`, `Try` in case of failure will preserve only first exception happened in call chain and skip further operations.
102+
Same as for `Optional`, `Try` in case of failure will preserve only first exception happened in a call chain and skip further operations.
119103

120104
## License
121105
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FSuppieRK%2Fjava-throwable-utils.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FSuppieRK%2Fjava-throwable-utils?ref=badge_large)

0 commit comments

Comments
 (0)