README.md in s3_patron-0.0.2 vs README.md in s3_patron-0.0.2.1
- old
+ new
@@ -20,19 +20,83 @@
$ export AWS_REGION="AWS REGION"
```
## Usage
+```shell
+#List of Commands:
+$ s3patron buckets [REGION(OPTIONAL)] # List all buckets
+$ s3patron create [BUCKET_NAME] [REGION(OPTIONAL)] # create bucket
+$ 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
+
```
-Commands:
- s3patron buckets REGION(OPTIONAL) # List all buckets
- s3patron create BUCKET_NAME REGION(OPTIONAL) # create bucket
- s3patron download BUCKET_NAME OBJECT DOWNLOAD_LOCATION(OPTIONAL) REGION(OPTIONAL) # 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) PATH_TO_FILE # Upload into bucket
+#Examples
+
+##List Buckets
+
+```shell
+#Normal
+$ s3patron buckets
+# Will list all buckets in your s3. By default it lists first 50 items
+
+$ 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
```
+
+##Create Bucket
+
+```shell
+#Normal
+$ s3patron create example_bucket
+# 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
+```
+
+##List Objects inside the bucket
+
+```shell
+#Normal
+$ s3patron list example_bucket
+# Will list all objects inside example_bucket in your s3. By default it lists first 50 items
+
+$ 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
+```
+
+##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
+```
+
+##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
+```
+
+
##Rubygems.org
Hosted at [Rubygems.org](https://rubygems.org/gems/s3_patron)
## License