Skip to content

Commit

Permalink
updated description (#106)
Browse files Browse the repository at this point in the history
  • Loading branch information
markjschreiber authored Jul 13, 2023
1 parent 8e6fbec commit 2e082e0
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,12 @@

A Java NIO.2 service provider for S3, allowing Java NIO operations to be performed on paths using the `s3` scheme. This
package implements the service provider interface (SPI) defined for Java NIO.2 in JDK 1.7 providing "plug-in" non-blocking
access to S3 objects for Java applications using Java NIO.2 for file access.
access to S3 objects for Java applications using Java NIO.2 for file access. Using this package allows Java applications
to access S3 without having to modify or recompile the application. You also avoid having to set up any kind of FUSE mount.

For a general overview see the
[AWS Blog Post](https://aws.amazon.com/blogs/storage/extending-java-applications-to-directly-access-files-in-amazon-s3-without-recompiling/)
announcing this package.

## Using this package as a provider

Expand Down Expand Up @@ -266,7 +271,7 @@ Code must compile to JDK 1.8 compatible bytecode. Matching unit tests are requir

### Contributing Unit Tests

We use JUnit 4 and Mockito for unit testing.
We use JUnit 5 and Mockito for unit testing.

When contributing code for bug fixes or feature improvements, matching tests should also be provided. Tests must not
rely on specific S3 bucket access or credentials. To this end, S3 clients and other artifacts should be mocked as
Expand Down

0 comments on commit 2e082e0

Please sign in to comment.