Skip to content

Commit 9d5ee81

Browse files
committed
add a note on versioning
1 parent bf582d5 commit 9d5ee81

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -437,6 +437,47 @@ You can write your own `provider` by implementing the `Provider` interface.
437437
You can provide your own `dumper` by implementing the `Dumper` interface.
438438

439439

440+
Versioning
441+
----------
442+
443+
Geocoder follows [Semantic Versioning](http://semver.org/).
444+
445+
### End Of Life
446+
447+
As of December 2014, branch `1.7` is not officially supported anymore, meaning
448+
major version `1` reached end of life. Last version is:
449+
[1.7.1](https://github.com/geocoder-php/Geocoder/releases/tag/1.7.1). This
450+
branch did not receive any new fixes over the last year, and all plugins/modules
451+
require Geocoder `2.0+`.
452+
453+
### Stable Version
454+
455+
Stable version
456+
[2.0.0](https://github.com/geocoder-php/Geocoder/releases/tag/2.0.0) has been
457+
released on July 2013, and it is the only known stable major version. Branch
458+
[`2.x`](https://github.com/geocoder-php/Geocoder/tree/2.x) is used to contribute
459+
bug and/or security fixes, and that is the one you should use in order to
460+
contribute.
461+
462+
Latest version is:
463+
[2.8.1](https://github.com/geocoder-php/Geocoder/releases/tag/2.8.1).
464+
465+
**Important:** as of December 2014, this version is in a **feature freeze**
466+
state. All new features should be contributed to (upcoming) version 3.0.
467+
468+
**Important:** version 2.0.0 does not have any EOL date scheduled yet.
469+
470+
### Next Version
471+
472+
Version 3.0.0 is the next major version of Geocoder. You can take a look at the
473+
`master` branch in order to follow its development. That is also why it is a bad
474+
idea to require `dev-master` into your `composer.json` file.
475+
476+
Branch `2.x` is merged into `master` time to time, so that all bug/security
477+
fixes contributed to the current stable version will also appear in the next
478+
version.
479+
480+
440481
Contributing
441482
------------
442483

0 commit comments

Comments
 (0)