Merge pull request #4 from takkt-ag/prepare-release

Small documentation improvements

Cargo.toml

@@ -13,7 +13,7 @@ license = "Apache-2.0"
 anyhow = "1.0.89"
 aws-config = "1.5.8"
 aws-sdk-s3 = { version = "1.55.0", features = ["http-1x"] }
-clap = { version = "4.5.20", features = ["derive"] }
+clap = { version = "4.5.20", features = ["derive", "wrap_help"] }
 http-body = "1.0.1"
 http-body-util = "0.1.2"
 serde = { version = "1.0.210", features = ["derive"] }

src/consts.rs

@@ -42,16 +42,14 @@ pub(crate) const MINIMUM_PART_NUMBER: u64 = 1;
 /// Source: https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html
 pub(crate) const MAXIMUM_PART_NUMBER: u64 = 10_000;
 
-/// Part size: 5 MiB to 5 GiB.
+/// Minimum part size: 5 MiB
 ///
 /// There is no minimum size limit on the last part of your multipart upload.
 ///
 /// Source: https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html
 pub(crate) const MINIMUM_PART_SIZE: u64 = 5 * MiB;
 
-/// Part size: 5 MiB to 5 GiB.
-///
-/// There is no minimum size limit on the last part of your multipart upload.
+/// Maximum part size: 5 GiB
 ///
 /// Source: https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html
 pub(crate) const MAXIMUM_PART_SIZE: u64 = 5 * GiB;

src/main.rs

@@ -124,6 +124,15 @@ impl State {
     }
 }
 
+/// With Persevere you can upload huge files to S3 without worrying about network interruptions or
+/// other issues. Persevere will allow you to resume the upload where it was left off, even in the
+/// case of a system crash during upload.
+///
+/// The contents of the file you upload are always streamed, which means the memory usage of
+/// Persevere is minimal, usually below 10 MB. This makes it possible to upload files of any size
+/// supported by S3, even if they are larger than the available memory of your system.
+///
+/// Source: <https://github.com/takkt-ag/persevere>
 #[derive(Debug, Parser)]
 #[command(version)]
 enum Cli {
@@ -141,6 +150,11 @@ enum Cli {
     ///
     /// * `s3:PutObject`
     /// * `s3:AbortMultipartUpload`
+    ///
+    /// Persevere will automatically discover valid AWS credentials like most AWS SDKs. This means
+    /// you can provide environment variables such as `AWS_PROFILE` to select the profile you want
+    /// to upload a file with, or provide the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`
+    /// directly.
     Upload(Upload),
     /// Resume the upload of a file to S3.
     ///
@@ -156,6 +170,11 @@ enum Cli {
     ///
     /// * `s3:PutObject`
     /// * `s3:AbortMultipartUpload`
+    ///
+    /// Persevere will automatically discover valid AWS credentials like most AWS SDKs. This means
+    /// you can provide environment variables such as `AWS_PROFILE` to select the profile you want
+    /// to upload a file with, or provide the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`
+    /// directly.
     Resume(Resume),
     /// Abort the upload of a file to S3.
     ///
@@ -168,6 +187,11 @@ enum Cli {
     ///
     /// * `s3:PutObject`
     /// * `s3:AbortMultipartUpload`
+    ///
+    /// Persevere will automatically discover valid AWS credentials like most AWS SDKs. This means
+    /// you can provide environment variables such as `AWS_PROFILE` to select the profile you want
+    /// to upload a file with, or provide the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`
+    /// directly.
     Abort(Abort),
 }