v1.0.0-beta1 (2024-02-01)

CHANGELOG.md

@@ -2,22 +2,26 @@ This project uses [**Break Versioning**](https://www.taoensso.com/break-versioni
 
 ---
 
-# `v1.0.0-alpha1` (2023-11-13)
+# `v1.0.0-beta1` (2024-02-01)
 
-> 📦 [Available on Clojars](https://clojars.org/com.taoensso/tempel/versions/1.0.0-alpha1), this project uses [Break Versioning](https://www.taoensso.com/break-versioning).
+> 📦 [Available on Clojars](https://clojars.org/com.taoensso/tempel/versions/1.0.0-beta1), this project uses [Break Versioning](https://www.taoensso.com/break-versioning).
 
-This is Tempel's first public pre-release.
+⚠️ **Please don't use this in production yet**, this release is intended for early testers and for those that would like to give feedback. Please report any unexpected problems and let me know if anything is unclear, inconvenient, etc. Now's the ideal time to get changes in. Thank you! 🙏
+
+## Changes since `v1.0.0-alpha1`
+
+* b38da78 [mod] Rename {:return :as-map} -> {:return :map}
 
-⚠️ **Please don't use this in production yet**, this release is intended for early testers and for those that would like to give feedback.
+## New since `v1.0.0-alpha1`
 
-Please report any unexpected problems and let me know if anything is unclear, inconvenient, etc. Now's the ideal time to get changes in. Thank you! 🙏
+* 674c849 [new] [#1] [#2] Add ChaCha20-Poly1305 AEAD cipher (@iarenaza)
 
-## Roadmap
+---
 
-Approximate timeline:
+# `v1.0.0-alpha1` (2023-11-13)
 
-- Jan 2024 - first beta release
-- Mar 2024 - first release candidate
-- May 2024 - first stable release
+> 📦 [Available on Clojars](https://clojars.org/com.taoensso/tempel/versions/1.0.0-alpha1), this project uses [Break Versioning](https://www.taoensso.com/break-versioning).
+
+This is Tempel's first public pre-release.
 
-\- [Peter Taoussanis](https://www.taoensso.com)
+⚠️ **Please don't use this in production yet**, this release is intended for early testers and for those that would like to give feedback. Please report any unexpected problems and let me know if anything is unclear, inconvenient, etc. Now's the ideal time to get changes in. Thank you! 🙏

README.md

@@ -11,7 +11,7 @@ It incorporates **best practices and reasonable defaults** to help simplify many
 
 ## Latest release/s
 
-- `2023-11-13` `1.0.0-alpha1`: [release notes](../../releases/tag/v1.0.0-alpha1)
+- `2024-02-01` `1.0.0-beta1`: [release notes](../../releases/tag/v1.0.0-beta1)
 
 [![Main tests][Main tests SVG]][Main tests URL]
 [![Graal tests][Graal tests SVG]][Graal tests URL]
@@ -35,14 +35,14 @@ Note that Tempel is [not intended](../../wiki/3-Faq#can-i-decrypt-tempel-data-wi
 
 Tempel has a fixed scope, and is **fully complete**. I'm happy with its design and implementation, and believe it meets all its objectives in its current form. I'm not anticipating significant changes.
 
-Still, given the sensitivity of the problem domain, I plan to approach Tempel's official stable release as a phased rollout to allow time for user feedback before locking things down:
+Still, given the sensitivity of the problem domain, I plan to approach Tempel's official stable release as a phased rollout to allow time for feedback before locking things down:
 
 | Phase | Date    | Release       | Appropriate for
 | :-:   | :--     | :--           | :--
-|  ➤    | 2023-11 | `v1.0-alpha`  | Dev/testing with disposable data
-|       | 2024-01 | `v1.0-beta`   | Dev/testing with disposable data
+|       | 2023-11 | `v1.0-alpha`  | Dev/testing with disposable data
+|  ➤    | 2024-02 | `v1.0-beta`   | Dev/testing with disposable data
 |       | 2024-03 | `v1.0-RC`     | Staging, with ephemeral or low-value data
-|       | 2024-05 | `v1.0` final  | Production, with real data
+|       | 2024-06 | `v1.0` final  | Production, with real data
 
 `v1.0` final will be considered "**done**"- the library is expected to need+see only minimal maintance from that point.
 
@@ -92,4 +92,4 @@ Licensed under [EPL 1.0](LICENSE.txt) (same as Clojure).
 [Main tests SVG]:  https://github.com/taoensso/tempel/actions/workflows/main-tests.yml/badge.svg
 [Main tests URL]:  https://github.com/taoensso/tempel/actions/workflows/main-tests.yml
 [Graal tests SVG]: https://github.com/taoensso/tempel/actions/workflows/graal-tests.yml/badge.svg
-[Graal tests URL]: https://github.com/taoensso/tempel/actions/workflows/graal-tests.yml
+[Graal tests URL]: https://github.com/taoensso/tempel/actions/workflows/graal-tests.yml

project.clj

@@ -1,4 +1,4 @@
-(defproject com.taoensso/tempel "1.0.0-alpha1"
+(defproject com.taoensso/tempel "1.0.0-beta1"
   :author "Peter Taoussanis <https://www.taoensso.com>"
   :description "Data security framework for Clojure"
   :url "https://github.com/taoensso/tempel"

wiki/1-Getting-started.md

@@ -67,14 +67,14 @@ In many cases, asymmetric encryption schemes will also use symmetric encryption.
 
 ## Challenges
 
-Working with encryption can be tough. Some of the challenges include:
+Working with encryption can be tough. Some of the most stressful and error-prone challenges in practice include:
 
-- Understanding **what keys you'll need** (key algorithms, parameters, etc.)
-- Understanding how **the various algorithms/schemes fit together** (e.g. when and how to use hybrid schemes)
-- Managing keys (changing algorithms or parameters, rotating keys, etc.)
-- Doing all the above without introducing vulnerabilities
+- Understanding **what keys you'll need** (algorithms, parameters, etc.).
+- Understanding how **the various algorithms/schemes fit together** (when and how to use hybrid schemes, etc.).
+- **Managing keys** (keeping algorithms and parameters up-to-date, rotating keys, etc.).
+- Doing all the above without introducing vulnerabilities, and without being dragged into a rat's nest of complexity irrelevant to your application.
 
-Tempel was designed to try help with each of these. Its API is **task oriented**, and tries to shield non-experts from unnecessary implementation details.
+Tempel was designed to try help with each of these.
 
 ## Keychains