From 504a73ab2bf0a4603343d94472d7c0bb5fd3b2c5 Mon Sep 17 00:00:00 2001 From: Jonathan Halterman Date: Wed, 22 Sep 2021 09:23:55 -0700 Subject: [PATCH] Update readme and add versioning doc --- README.md | 2 +- VERSIONING.md | 9 +++++++++ 2 files changed, 10 insertions(+), 1 deletion(-) create mode 100644 VERSIONING.md diff --git a/README.md b/README.md index b67329dd..5f502676 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Failsafe is a lightweight, zero-dependency library for handling failures in Java ## Usage -Visit [failsafe.dev](https://failsafe.dev) for docs, usage info, and more. +Visit [failsafe.dev](https://failsafe.dev) for usage info, docs, and additional resources. ## Contributing diff --git a/VERSIONING.md b/VERSIONING.md new file mode 100644 index 00000000..144e1291 --- /dev/null +++ b/VERSIONING.md @@ -0,0 +1,9 @@ +### Versioning + +Failsafe follows MAJOR.MINOR.PATCH versioning where: + +- MAJOR versions contain significant new features and potentially significant incompatible API changes. +- MINOR versions contain new features and potentially minor yet incompatible API changes. +- PATCH versions contain bug fixes and minor new features that are fully backwards compatible. + +All versions, new features, and API changes are described in the [CHANGELOG](CHANGELOG.md). \ No newline at end of file