docs: hygiene sweep — README, SECURITY, CHANGELOG#2
Merged
peo-machine merged 1 commit intomainfrom Apr 23, 2026
Merged
Conversation
- README: badge row (CI + Maven Central + License), three-section Usage reorder (raw key / Argon2id / legacy-PBKDF2 explainer), Install section moved above Usage, minor wording alignment with the other new-language READMEs. - SECURITY.md: standard policy pointing at GitHub Private Vulnerability Reporting, consistent with tokencrypt-python and tokencrypt-rust. - CHANGELOG.md: seeded with the v1.0.0 entry. Per the 3ncr.org new-language convention and consistent with the actual source (PR #1 dropped legacy PBKDF2-SHA3), the third Usage section explains how to recover the legacy key externally rather than documenting a nonexistent factory. LICENSE stays at 2026 (repo created this year).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Docs & hygiene bundle for
tokencrypt-java, matching the pattern alreadyshipped in
tokencrypt-python(#2, merged) andtokencrypt-rust(#2).into the canonical three sections (raw key / Argon2id / legacy-PBKDF2
explainer), move the JDK / Bouncy Castle prerequisite into the Install
section, align copy with the other new-language READMEs.
Reporting (same file as the other new-language repos).
Per the 3ncr.org new-language convention
and consistent with the actual source (PR #1 dropped legacy PBKDF2-SHA3),
the third Usage section explains how to recover the legacy key externally
(
PKCS5S2ParametersGenerator+SHA3Digest(256)→fromRawKey) ratherthan documenting a factory that no longer exists.
LICENSEstays at2026(repo created this year), per §5b.
Test plan
source or
pom.xmltouched.main.