Browse Source

feat(README): at a versioning section

Brandon Philips 12 years ago
parent
commit
f8e68ba272
1 changed files with 18 additions and 0 deletions
  1. 18 0
      README.md

+ 18 - 0
README.md

@@ -449,3 +449,21 @@ If you are using SSL for server to server communication, you must use it on all
 **Chef Cookbook**
 
 - [spheromak/etcd-cookbook](https://github.com/spheromak/etcd-cookbook)
+
+## Project Details
+
+### Versioning
+
+etcd uses [semantic versioning][semver].
+When we release v1.0.0 of etcd we will promise not to break the "v1" REST API.
+New minor versions may add additional features to the API however.
+
+You can get the version of etcd by requesting the root path of etcd:
+
+```sh
+curl -L http://127.0.0.1:4001
+```
+
+During the v0 series of releases we may break the API as we fix bugs and get feedback.
+
+[semver]: http://semver.org/