Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gheine committed Jan 21, 2020
1 parent 72bcd3f commit 0f3118b
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 31 deletions.
25 changes: 0 additions & 25 deletions LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -174,28 +174,3 @@
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "{}"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2017 Gilt Groupe, Hudson Bay Company

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,25 @@
# gfc-aws-s3 [![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.gfccollective/gfc-aws-s3_2.12/badge.svg?style=plastic)](https://maven-badges.herokuapp.com/maven-central/org.gfccollective/gfc-aws-s3_2.12) [![Build Status](https://travis-ci.com/gilt/gfc-aws-s3.svg?token=GMHJnzRkMmqWsbzuEWgW&branch=master)](https://travis-ci.com/gilt/gfc-aws-s3)

Tools for streaming data to and from S3. Part of the [Gilt Foundation Classes](https://github.com/gilt?q=gfc).
Tools for streaming data to and from S3.
A fork and new home of the former Gilt Foundation Classes (`com.gilt.gfc`), now called the [GFC Collective](https://github.com/gfc-collective), maintained by some of the original authors.

## Usage

The library provides tools to integrate akka-streams with Amazon S3 storage service. To use it add to your dependencies:
## Getting gfc-collection

The latest version is 1.0.0, which is cross-built against Scala 2.12.x and 2.13.x.

```sbt
"org.gfccollective" %% "gfc-aws-s3" % "0.1.0"
If you're using SBT, add the following line to your build file:

```scala
libraryDependencies += "org.gfccollective" %% "gfc-aws-s3" % "1.0.0"
```

For Maven and other build tools, you can visit [search.maven.org](http://search.maven.org/#search%7Cga%7C1%7Corg.gfccollective).
(This search will also list other available libraries from the GFC Collective.)

## Usage

The library provides tools to integrate akka-streams with Amazon S3 storage service.
The library contains akka-stream Sources and Sinks to Stream data from and to S3.

### Sinks
Expand Down Expand Up @@ -86,7 +96,6 @@ The pieces of code above will crease a Source[ByteString], where each ByteString

## Copyright and license

Copyright 2017 Gilt Groupe, Hudson's Bay Company

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Expand Down

0 comments on commit 0f3118b

Please sign in to comment.