README.md in stashify-aws-s3-1.1.0 vs README.md in stashify-aws-s3-1.2.0
- old
+ new
@@ -1,11 +1,9 @@
# Stashify::Aws::S3
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/stashify/aws/s3`. To experiment with that code, run `bin/console` for an interactive prompt.
+This is an implementation of the [Stashify](https://rubydoc.info/gems/stashify) abstraction for AWS S3. It operates under the assumption that the "/" in file names has the typical meaning of a path separater.
-TODO: Delete this and the text above, and describe your gem
-
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -20,10 +18,31 @@
$ gem install stashify-aws-s3
## Usage
-TODO: Write usage instructions here
+This implementation is built on top of an instance of `Aws::S3::Bucket`. The following usage is an abbreviated form to illustrate how to engage in this particular library. For a more extensive example see [Stashify's Usage](https://rubydoc.info/gems/stashify#usage).
+
+```ruby
+> require "aws-sdk-s3"
+=> true
+> s3 = Aws::S3::Resource.new
+=> #<Aws::S3::Resource:0x0000558723dad2e8 @client=#<Aws::S3::Client>>
+irb(main):005:0> bucket = s3.bucket("some-bucket")
+=>
+#<Aws::S3::Bucket:0x0000558723f5a6e0
+...
+> file.contents
+=> "foo"
+> require "stashify/directory/aws/s3"
+=> true
+> dir = Stashify::Directory::AWS::S3.new(bucket: bucket, path: "path/to")
+=>
+#<Stashify::Directory::AWS::S3:0x000055872460c628
+...
+> dir.find("file") == file
+=> true
+```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.