chore: update readme

Author: bchew

README.md

@@ -1,17 +1,25 @@
 # dynamodump
 
-![Linting Status](https://github.com/bchew/dynamodump/workflows/Linting/badge.svg) ![Test Status](https://github.com/bchew/dynamodump/workflows/Test/badge.svg) [![DockerBuildstatus](https://img.shields.io/docker/build/bchew/dynamodump.svg)](https://hub.docker.com/r/bchew/dynamodump/)
+[![PyPI version](https://badge.fury.io/py/dynamodump.svg)](https://badge.fury.io/py/dynamodump)
+![Linting Status](https://github.com/bchew/dynamodump/workflows/Linting/badge.svg)
+![Test Status](https://github.com/bchew/dynamodump/workflows/Test/badge.svg)
 
 Simple backup and restore script for Amazon DynamoDB using AWS SDK for Python (boto3) to work similarly to mysqldump.
 
 Suitable for DynamoDB usages of smaller data volume which do not warrant the usage of AWS Data Pipeline for backup/restores/empty.
 
 dynamodump supports local DynamoDB instances as well (tested with [DynamoDB Local](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.html)).
 
+## Installation
+
+```
+pip install dynamodump
+```
+
 ## Usage
 
 ```
-usage: dynamodump/dynamodump.py [-h] [-a {zip,tar}] [-b BUCKET]
+usage: dynamodump [-h] [-a {zip,tar}] [-b BUCKET]
                      [-m {backup,restore,empty}] [-r REGION] [--host HOST]
                      [--port PORT] [--accessKey ACCESSKEY]
                      [--secretKey SECRETKEY] [-p PROFILE] [-s SRCTABLE]
@@ -96,73 +104,73 @@ As of v1.2.0, note that `--noConfirm` is required to perform data restores invol
 Single table backup/restore:
 
 ```
-python dynamodump/dynamodump.py -m backup -r us-west-1 -s testTable
+dynamodump -m backup -r us-west-1 -s testTable
 
-python dynamodump/dynamodump.py -m restore -r us-west-1 -s testTable
+dynamodump -m restore -r us-west-1 -s testTable
 ```
 
 Multiple table backup/restore (assumes prefix of 'production-' of table names, use --prefixSeparator to specify a
 different separator):
 
 ```
-python dynamodump/dynamodump.py -m backup -r us-west-1 -s production*
+dynamodump -m backup -r us-west-1 -s production*
 
-python dynamodump/dynamodump.py -m restore -r us-west-1 -s production*
+dynamodump -m restore -r us-west-1 -s production*
 ```
 
 The above, but between different environments (e.g. production-_ tables to development-_ tables):
 
 ```
-python dynamodump/dynamodump.py -m backup -r us-west-1 -s production*
+dynamodump -m backup -r us-west-1 -s production*
 
-python dynamodump/dynamodump.py -m restore -r us-west-1 -s production* -d development*
+dynamodump -m restore -r us-west-1 -s production* -d development*
 ```
 
 Backup all tables and restore only data (will not delete and recreate schema):
 
 ```
-python dynamodump/dynamodump.py -m backup -r us-west-1 -s "*"
+dynamodump -m backup -r us-west-1 -s "*"
 
-python dynamodump/dynamodump.py -m restore -r us-west-1 -s "*" --dataOnly
+dynamodump -m restore -r us-west-1 -s "*" --dataOnly
 ```
 
 Dump all table schemas and create the schemas (e.g. creating blank tables in a different AWS account):
 
 ```
-python dynamodump/dynamodump.py -m backup -r us-west-1 -p source_credentials -s "*" --schemaOnly
+dynamodump -m backup -r us-west-1 -p source_credentials -s "*" --schemaOnly
 
-python dynamodump/dynamodump.py -m restore -r us-west-1 -p destination_credentials -s "*" --schemaOnly
+dynamodump -m restore -r us-west-1 -p destination_credentials -s "*" --schemaOnly
 ```
 
 Backup all tables based on AWS tag `key=value`
 
 ```
-python dynamodump/dynamodump.py -p profile -r us-east-1 -m backup -t KEY=VALUE
+dynamodump -p profile -r us-east-1 -m backup -t KEY=VALUE
 ```
 
 Backup all tables based on AWS tag, compress and store in specified S3 bucket.
 
 ```
-python dynamodump/dynamodump.py -p profile -r us-east-1 -m backup -a tar -b some_s3_bucket -t TAG_KEY=TAG_VALUE
+dynamodump -p profile -r us-east-1 -m backup -a tar -b some_s3_bucket -t TAG_KEY=TAG_VALUE
 
-python dynamodump/dynamodump.py -p profile -r us-east-1 -m backup -a zip -b some_s3_bucket -t TAG_KEY=TAG_VALUE
+dynamodump -p profile -r us-east-1 -m backup -a zip -b some_s3_bucket -t TAG_KEY=TAG_VALUE
 ```
 
 Restore from S3 bucket to specified destination table
 
 ```
 ## source_table identifies archive file in S3 bucket from which backup data is restored
-python dynamodump/dynamodump.py -a tar -b some_s3_bucket -m restore -r us-east-1 -p profile -d destination_table -s source_table
+dynamodump -a tar -b some_s3_bucket -m restore -r us-east-1 -p profile -d destination_table -s source_table
 ```
 
 ## Local example
 
 The following assumes your local DynamoDB is running on localhost:8000 and is accessible via 'a' as access/secret keys.
 
 ```
-python dynamodump/dynamodump.py -m backup -r local -s testTable --host localhost --port 8000 --accessKey a --secretKey a
+dynamodump -m backup -r local -s testTable --host localhost --port 8000 --accessKey a --secretKey a
 
-python dynamodump/dynamodump.py -m restore -r local -s testTable --host localhost --port 8000 --accessKey a --secretKey a
+dynamodump -m restore -r local -s testTable --host localhost --port 8000 --accessKey a --secretKey a
 ```
 
 Multiple table backup/restore as stated in the AWS examples are also available for local.

dynamodump/dynamodump.py

@@ -5,7 +5,7 @@
     Suitable for DynamoDB usages of smaller data volume which do not warrant the usage of AWS
     Data Pipeline for backup/restores/empty.
 
-    dynamodump supports local DynamoDB instances as well (tested with dynalite).
+    dynamodump supports local DynamoDB instances as well (tested with DynamoDB Local).
 """
 
 import argparse