Permalink
Browse files

updated README with a warning about read streaming issue

  • Loading branch information...
1 parent 88b3994 commit 94a72138eb6066d052ce990f767241514c02ff64 @arp arp committed Mar 14, 2013
Showing with 5 additions and 0 deletions.
  1. +5 −0 README.md
View
@@ -8,6 +8,10 @@ Amazon's official AWS SDK provides an API for S3 that isn't compatible with Ruby
Currently only reads are supported with writes support coming soon.
+## Warning
+
+Reads currently don't guarantee consistency if S3 file changes while being streamed. I plan to solve this, but meanwhile please keep in mind that you may read garbage if you replace S3 file while streaming it.
+
## Installation
Add this line to your application's Gemfile:
@@ -61,6 +65,7 @@ It can write:
## To do
* Code documentation
+* Fix an issue where S3 file that is updated while read streaming happens may result in garbage being read
## Contributing

0 comments on commit 94a7213

Please sign in to comment.