From c8569d871a10a9b00ea859a8f7ad42078086c711 Mon Sep 17 00:00:00 2001 From: Vincent Hanquez Date: Mon, 18 Sep 2017 10:29:09 +0100 Subject: [PATCH] Fix the old blurb about versioning since it confuses some people. Reflect what's already been in place for more than a year now regarding versioning and API stability --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f65ceeb..56b1b98 100644 --- a/README.md +++ b/README.md @@ -16,13 +16,23 @@ Instead, rely on higher level protocols or implementations. Documentation: [cryptonite on hackage](http://hackage.haskell.org/package/cryptonite) +Stability +--------- + +Cryptonite APIs are stable, and we only strive to add, not change or remove. +Note that because the API exposed is wide and also expose internals things (for +power users and flexibility), certains APIs can be revised in extreme cases +where we can't just add. + Versioning ---------- -Development versions are an incremental number prefixed by 0. There is no -API stability between development versions. +Next version of `0.x` is `0.(x+1)`. There's no exceptions, or API related meaning +behind the numbers. -Production versions : TBD +Each versions of stackage (going back 3 stable LTS) has a cryptonite version +that we maintain with security fixes when necessary and are versioned with the +following `0.x.y` scheme. Coding Style ------------