Permalink
Browse files

Add Versioning section [ci skip]

  • Loading branch information...
1 parent 695ce8b commit e34cf672cd02d5ff44c7b3c8eaf9b6ea78f3237a @sferik sferik committed Dec 3, 2012
Showing with 16 additions and 0 deletions.
  1. +16 −0 README.md
View
@@ -142,6 +142,22 @@ OmniAuth, how it works, and how to use it.
OmniAuth is tested under 1.8.7, 1.9.2, 1.9.3, JRuby (1.8 mode), and Rubinius
(1.8 and 1.9 modes).
+## Versioning
+
+This library aims to adhere to [Semantic Versioning 2.0.0][semver]. Violations
+of this scheme should be reported as bugs. Specifically, if a minor or patch
+version is released that breaks backward compatibility, that version should be
+immediately yanked and/or a new version should be immediately released that
+restores compatibility. Breaking changes to the public API will only be
+introduced with new major versions. As a result of this policy, you can (and
+should) specify a dependency on this gem using the [Pessimistic Version
+Constraint][pvc] with two digits of precision. For example:
+
+ spec.add_dependency 'omniauth', '~> 1.0'
+
+[semver]: http://semver.org/
+[pvc]: http://docs.rubygems.org/read/chapter/16#page74
+
## License
Copyright (c) 2010-2013 Michael Bleigh and Intridea, Inc.

0 comments on commit e34cf67

Please sign in to comment.