Add a README

Author: orf

README.md

@@ -1,6 +1,16 @@
 # esdump-rs
 
-Dump elasticsearch indexes to blob storage, really-really fast :rocket:
+Dump Elasticsearch or OpenSearch  indexes to blob storage, really-really fast :rocket:
+
+Features:
+- Super-dooper fast
+- Compression with gzip or JSON
+- Comes as a single, small static binary
+- Natively supports blob storage on AWS, Google Cloud and Azure
+- Detailed progress output and logging
+- Written in Rust :crab:
+
+![](./images/readme.gif)
 
 ## Installation
 
@@ -10,6 +20,53 @@ Dump elasticsearch indexes to blob storage, really-really fast :rocket:
 
 ## Usage
 
+Pass the Elasticsearch or OpenSearch HTTP(s) URL and a blob storage URL. Set the credentials in the environment
+(see [example.env](./example.env)), and run!
+
+```shell
+$ esdump-rs http://localhost:9200 s3://es-dump/test/ \
+  --index=test-index \
+  --batches-per-file=5 \
+  --batch-size=5000 \
+  --concurrency=10
+```
+
+Settings such as the batch size and concurrency can be set as flags
+
 ```shell
-cargo run --profile release http://localhost:9200 --index=test-index --batches-per-file=5 --batch-size=5000 s3://es-dump/test/ --env-file=test.env --concurrency=10
+Usage: esdump-rs [OPTIONS] --index <INDEX> --concurrency <CONCURRENCY> --batch-size <BATCH_SIZE> --batches-per-file <BATCHES_PER_FILE> <ELASTICSEARCH_URL> <OUTPUT_LOCATION>
+
+Arguments:
+  <ELASTICSEARCH_URL>  Elasticsearch cluster to dump
+  <OUTPUT_LOCATION>    Location to write results. Can be a file://, s3:// or gs:// URL
+
+Options:
+  -i, --index <INDEX>
+          Index to dump
+  -c, --concurrency <CONCURRENCY>
+          Number of concurrent requests to use
+  -l, --limit <LIMIT>
+          Limit the total number of records returned
+  -b, --batch-size <BATCH_SIZE>
+          Number of records in each batch
+      --batches-per-file <BATCHES_PER_FILE>
+          Number of batches to write per file
+  -q, --query <QUERY>
+          A file path containing a query to execute while dumping
+  -f, --field <FIELD>
+          Specific fields to fetch
+      --compression <COMPRESSION>
+          Compress the output files [default: zstd] [possible values: gzip, zstd]
+      --concurrent-uploads <CONCURRENT_UPLOADS>
+          Max chunks to concurrently upload *per task*
+      --upload-size <UPLOAD_SIZE>
+          Size of each uploaded [default: 15MB]
+  -d, --distribution <DISTRIBUTION>
+          Distribution of the cluster [possible values: elasticsearch, opensearch]
+      --env-file <ENV_FILE>
+          Distribution of the cluster [default: .env]
+  -h, --help
+          Print help
+  -V, --version
+          Print version
 ```

example.env

@@ -0,0 +1,2 @@
+ES_DUMP_USERNAME=foo
+ES_DUMP_PASSWORD=bar