Merge pull request #7 from resend/0.6.0

0.6.0

CHANGELOG.md

@@ -8,6 +8,16 @@ and this project adheres to
 
 <!-- ## [Unreleased] -->
 
+## [0.6.0] - 2024-06-16
+
+### Changed
+
+- `RATE_LIMIT` to `RESEND_RATE_LIMIT` to avoid potential collisions with other libs
+
+### Removed
+
+- Outdated doc comment from `Client::user_agent`
+
 ## [0.5.2] - 2024-06-10
 
 ### Added
@@ -93,6 +103,7 @@ Disabled `reqwest`'s default features and enabled `rustls-tls`.
 
 Initial release.
 
+[0.6.0]: https://crates.io/crates/resend-rs/0.6.0
 [0.5.2]: https://crates.io/crates/resend-rs/0.5.2
 [0.5.1]: https://crates.io/crates/resend-rs/0.5.1
 [0.5.0]: https://crates.io/crates/resend-rs/0.5.0

Cargo.toml

@@ -2,7 +2,7 @@
 
 [package]
 name = "resend-rs"
-version = "0.5.2"
+version = "0.6.0"
 edition = "2021"
 
 license = "MIT"

README.md

@@ -35,7 +35,7 @@ Crate documentation is available in [docsrs][docs-url]. Example usage is availab
 - `RESEND_API_KEY` to enable `impl Default` for a `Resend` client (Required).
 - `RESEND_BASE_URL` to override the default base address:
   `https://api.resend.com` (Optional).
-- `RATE_LIMIT` to set the maximum amount of requests you can send per second. By default, this is
+- `RESEND_RATE_LIMIT` to set the maximum amount of requests you can send per second. By default, this is
   9 (Resend defaults to 10). In reality, the time window is set to 1.1s to avoid
   failures. This is thread-safe (as long as you use the same `Resend` client across threads!)
 

src/client.rs

@@ -61,10 +61,6 @@ impl Resend {
     }
 
     /// Returns the reference to the used `User-Agent` header value.
-    ///
-    /// ### Notes
-    ///
-    /// Use the `RESEND_USER_AGENT` environment variable to override.
     #[inline]
     #[must_use]
     pub fn user_agent(&self) -> &str {

src/config.rs

@@ -40,10 +40,10 @@ impl Config {
 
         // ==== Rate limiting is a non-blocking thing only ====
         #[cfg(not(feature = "blocking"))]
-        let rate_limit_per_sec = env::var("RATE_LIMIT")
+        let rate_limit_per_sec = env::var("RESEND_RATE_LIMIT")
             .unwrap_or_else(|_| "9".to_owned())
             .parse::<u32>()
-            .expect("env variable `RATE_LIMIT` should be a valid u32");
+            .expect("env variable `RESEND_RATE_LIMIT` should be a valid u32");
 
         #[cfg(not(feature = "blocking"))]
         let quota = Quota::with_period(Duration::from_millis(1100))