Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
skjolber committed Oct 13, 2023
1 parent c741e07 commit 0db217d
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,27 @@ Bugs, feature suggestions and help requests can be filed with the [issue-tracker
# Obtain
The project is based on [Maven] and is available at Maven central repository.

Example dependency config:
<details>
<summary>Maven coordinates</summary>

Add

```xml
<async-stax-utils.version>1.0.3</async-stax-utils.version>
```

and

```xml
<dependency>
<groupId>com.github.skjolber</groupId>
<artifactId>async-stax-utils</artifactId>
<version>1.0.2</version>
<version>${async-stax-utils.version}</version>
</dependency>
```

</details>

# Usage
The asynchronous nature adds some processing overhead and setup complexity compared to regular synchronous approach. If you prefer skipping to code examples, see [unit tests](src/test/java/com/github/skjolber/asyncstaxutils).

Expand Down Expand Up @@ -108,12 +119,12 @@ DelegateOutputStream dis = new DelegateOutputStream(bin, listener, callback);
streams and pass them up or down your pipe.

# History
- [1.0.2]: Better class names and packages, some some reuse of XML-related processors.
- 1.0.3: Maintenance release; bumped dependencies and added modules
- 1.0.2: Better class names and packages, some some reuse of XML-related processors.
- 1.0.1: Better document-size length filtering.
- 1.0.0: Initial release.

[Apache 2.0]: http://www.apache.org/licenses/LICENSE-2.0.html
[Aalto-xml]: https://github.com/FasterXML/aalto-xml
[issue-tracker]: https://github.com/skjolber/async-stax-utils/issues
[1.0.2]: https://github.com/skjolber-async-stax-utils/releases
[Maven]: http://maven.apache.org/

0 comments on commit 0db217d

Please sign in to comment.