Skip to content

Commit eadbe58

Browse files
committed
Prepare for release
[ci skip]
1 parent 6963151 commit eadbe58

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ A collection of classes to work with GIS geometries.
77

88
[![Build Status](https://secure.travis-ci.org/brick/geo.svg?branch=master)](http://travis-ci.org/brick/geo)
99
[![Coverage Status](https://coveralls.io/repos/brick/geo/badge.svg?branch=master)](https://coveralls.io/r/brick/geo?branch=master)
10+
[![Latest Stable Version](https://poser.pugx.org/brick/geo/v/stable)](https://packagist.org/packages/brick/geo)
1011
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](http://opensource.org/licenses/MIT)
1112

1213
Introduction
@@ -28,14 +29,27 @@ Just define the following requirement in your `composer.json` file:
2829

2930
{
3031
"require": {
31-
"brick/geo": "dev-master"
32+
"brick/geo": "0.1.*"
3233
}
3334
}
3435

3536
Then head on to the [Configuration](#configuration) section to configure a GIS geometry engine.
3637

3738
Failure to configure a geometry engine would result in a `GeometryEngineException` being thrown when trying to use a method that requires one.
3839

40+
Project status & release process
41+
--------------------------------
42+
43+
This library is still under development.
44+
45+
The current releases are numbered `0.x.y`. When a non-breaking change is introduced (adding new methods, optimizing existing code, etc.), `y` is incremented.
46+
47+
**When a breaking change is introduced, a new `0.x` version cycle is always started.**
48+
49+
It is therefore safe to lock your project to a given release cycle, such as `0.1.*`.
50+
51+
If you need to upgrade to a newer release cycle, check the [release history](https://github.com/brick/geo/releases) for a list of changes introduced by each further `0.x.0` version.
52+
3953
Configuration
4054
-------------
4155

0 commit comments

Comments
 (0)