diff options
| author | Rasmus Dahlberg <rgdd@glasklarteknik.se> | 2024-11-01 10:12:45 +0100 |
|---|---|---|
| committer | Rasmus Dahlberg <rgdd@glasklarteknik.se> | 2024-11-01 11:37:09 +0100 |
| commit | 1b2f3ddc0503d63b1e1b90ba7ebfb6098a3975d2 (patch) | |
| tree | 6b042d4241737f533f3213b5879f278175411112 | |
| parent | a8458e2e30fcc27f6a883cec13f977d63580455d (diff) | |
Say a few words about beta tags and releases
| -rw-r--r-- | README.md | 3 | ||||
| -rw-r--r-- | RELEASES | 28 |
2 files changed, 30 insertions, 1 deletions
@@ -4,7 +4,8 @@ An implementation of a silent Certificate Transparency monitor. ## Status -Drafty prototype, please do not use for anything too serious yet. +Drafty prototype, please do not use for anything too serious yet. See +[RELEASES](./RELEASES) for information on what can be expected right now. ## How it works diff --git a/RELEASES b/RELEASES new file mode 100644 index 0000000..0c2e0e1 --- /dev/null +++ b/RELEASES @@ -0,0 +1,28 @@ +---Overview + +The silentct software is not stable and well-tested yet. Please read the NEWS +file for information on how to upgrade from one beta version to the next. + +The git-tag convention for versioning is + + beta.NUM + +where NUM is a monotonic counter. + +By the terms of the LICENSE you are free to use this code "as is" in almost any +way you like. But for now, beta-use is only supported via the programs in cmd/. +This means the NEWS file is only targeted towards users of the cmd/ programs. + +See + + https://git.glasklar.is/rgdd/silentct/-/issues + +for an outlook of what we might be working on next. + +---Release cheat-sheet + + * Makefile works and produces reasonable man pages + * Quickstart instructions in the README file works + * NEWS file describes what changed from a cmd/ perspective + * Bump version in README + * Push next beta.NUM tag |