Skip to content

Commit

Permalink
[doc] Document release roadmap + stability goals
Browse files Browse the repository at this point in the history
  • Loading branch information
ptaoussanis committed Nov 30, 2023
1 parent 7d755e0 commit 4d7ef1c
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,22 @@ See [here][GitHub releases] for earlier releases.

Note that Tempel is [not intended](../../wiki/3-Faq#can-i-decrypt-tempel-data-with-other-tools) for interop with other cryptographic tools/APIs.

## Roadmap

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:

| 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
| | 2024-03 | `v1.0-RC` | Staging, with ephemeral or low-value data
| | 2024-05 | `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.

## Disclaimer

**Important**: while Tempel has been written and tested with care, the nature of the problem domain inevitably means that bugs and/or misuse can be **especially harmful and/or easy to make**.
Expand Down

0 comments on commit 4d7ef1c

Please sign in to comment.