README.md in s3_patron-0.0.2.1 vs README.md in s3_patron-0.0.2.2
- old
+ new
@@ -5,11 +5,11 @@
## Setup
Make sure [Ruby](https://www.ruby-lang.org/en/documentation/installation/) is installed.
-Add this line to your application's Gemfile:
+Execute:
```
$ gem install s3_patron
```
Set ENV variables
@@ -29,10 +29,11 @@
$ s3patron download [BUCKET_NAME] [OBJECT] [DOWNLOAD_LOCATION(default=CURRENT DIR)] [REGION(default=ENV[AWS_REGION])] # Download object from bucket
$ s3patron help [COMMAND] # Describe Commands
$ s3patron list [BUCKET_NAME] [REGION(OPTIONAL)] # List objects inside bucket
$ s3patron upload [BUCKET_NAME] [FILE] [REGION(OPTIONAL)] # Upload into bucket
+#You can also use s3p instead of s3patron
```
#Examples
##List Buckets
@@ -45,10 +46,12 @@
$ s3patron buckets -a
# passing -a flag will list all items with no limit.
$ s3patron buckets -l 10 #will show first 10 buckets
# You can customize number of results by passing -l flag followed by limit
+
+#You can also use s3p instead of s3patron
```
##Create Bucket
```shell
@@ -57,10 +60,12 @@
# Will create a bucket named example_bucket
#Optional
# If you do not want to use the AWS REGION defined in env variables you can pass region as next argument to create
$ s3patron create example_bucket us-east-1
+
+#You can also use s3p instead of s3patron
```
##List Objects inside the bucket
```shell
@@ -71,29 +76,35 @@
$ s3patron list example_bucket -a
# passing -a flag will list all items with no limit.
$ s3patron list example_bucket -l 10 #will show first 10 buckets
# You can customize number of results by passing -l flag followed by limit
+
+#You can also use s3p instead of s3patron
```
##Upload into a bucket
```shell
#Normal
$ s3patron upload example_bucket example_file.txt
# Will upload example_file.txt to example_bucket
#Optional
# If you do not want to use the AWS REGION defined in env variables you can pass region as next argument
+
+#You can also use s3p instead of s3patron
```
##Download object from bucket
```shell
#Normal
$ s3patron download example_bucket example_file.txt
# Will download example_file.txt to current directory
#Optional
# If you do not want to use the AWS REGION defined in env variables you can pass region as next argument
+
+#You can also use s3p instead of s3patron
```
##Rubygems.org