From 6ae3df4325221b42cf744dc7f571e3365339a761 Mon Sep 17 00:00:00 2001 From: Pieter van de Bruggen Date: Mon, 28 Feb 2011 19:30:58 -0800 Subject: Clarifying semantic versioning. --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 13b6f97..d5366e3 100644 --- a/README.md +++ b/README.md @@ -2,20 +2,24 @@ The repository at https://github.com/mustache/spec is the formal standard for Mustache. It defines both normal usage and edge-case behavior for libraries parsing the Mustache templating language (or a superset thereof). +The specification is developed as a series of YAML files, under the `specs` +directory. + +Versioning +---------- This specification is being [semantically versioned](http://semver.org). Roughly described, major version changes will always represent backwards incompatible changes, minor version changes will always represent new language features and will be backwards compatible, and patch ('tiny') version changes -will always be bug fixes. +will always be bug fixes. For the purposes of semantic versioning, the public +API is the contents of the `specs` directory and the algorithm for testing +against it. Mustache implementations SHOULD report the most recent version of the spec (major and minor version numbers) they have support for. It is RECOMMENDED that implementations supporting at least v1.0.0 of this spec refer to themselves as "Mustache-like", or "Mustache-inspired". -The specification is developed as a series of YAML files, under the `specs` -directory. - Alternate Formats ----------------- -- cgit v1.2.1