Update readme and add versioning doc

failsafe-lib · Sep 22, 2021 · 504a73a · 504a73a
1 parent 18f4a82
commit 504a73a
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git 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
@@ -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).