Skip to content

Commit 4a56da7

Browse files
committed
Update README and changelog
1 parent 26ad337 commit 4a56da7

File tree

3 files changed

+19
-9
lines changed

3 files changed

+19
-9
lines changed

CHANGELOG.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## Changelog
22

3-
### 0.9.0 (2023-xx-xx)
3+
### 0.9.0 (2023-03-14)
44

5-
- Add support for building isolines as MultiLineStrings (instead of solely building contour polygons as MultiPolygons).
5+
- Add support for building isolines as `MultiLineString`s (instead of solely building contour polygons as MultiPolygons).
66

7-
- Improve some minor details in the documentation.
7+
- Improve some minor details in the documentation and in the README (notably to refer to the [contour-isobands](https://github.com/mthh/contour-isobands-rs) crate)
88

99
### 0.8.0 (2023-02-21)
1010

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "contour"
3-
version = "0.8.0"
3+
version = "0.9.0"
44
authors = ["Matthieu Viry <[email protected]>"]
55
edition = "2021"
66

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,21 @@
66

77
Computes *isorings* and __*contour polygons*__ by applying [marching squares](https://en.wikipedia.org/wiki/Marching_squares) to a rectangular array of numeric values.
88
Outputs ring coordinates or polygons contours (represented using geo-types [MultiPolygon](https://docs.rs/geo-types/latest/geo_types/geometry/struct.MultiPolygon.html)s).
9+
For each threshold value, the contour polygon are representing the area where the input values are greater than or equal to the threshold value.
10+
911
The generated contours can also easily be serialised to GeoJSON.
1012

1113
*Note : This is a port of [d3-contour](https://github.com/d3/d3-contour).*
1214

1315
<div style="text-align:center"><a href="https://mthh.github.io/wasm_demo_contour/"><img src ="https://raw.githubusercontent.com/mthh/contour-rs/master/illustration.png" /></a></div><br>
1416

15-
### Usage
17+
## Usage
1618

1719
Add this to your `Cargo.toml`:
1820

1921
```toml
2022
[dependencies]
21-
contour = "0.8.0"
23+
contour = "0.9.0"
2224
```
2325

2426
and this to your crate root:
@@ -37,7 +39,7 @@ The API exposes:
3739

3840
`ContourBuilder` is the recommended way to use this crate, as it is more flexible and easier to use (it enables to specify the origin and the step of the grid, and to smooth the contours, while `contour_rings` only speak in grid coordinates and doesn't smooth the resulting rings).
3941

40-
### Example:
42+
## Example:
4143

4244
**Without defining origin and step:**
4345

@@ -140,10 +142,18 @@ Feature {
140142
}
141143
```
142144

143-
### Demo
145+
## WASM demo
144146

145147
Demo of this crate compiled to WebAssembly and used from JavaScript : [wasm_demo_contour](https://mthh.github.io/wasm_demo_contour/).
146148

149+
## Difference with the [contour-isobands](https://crates.io/crates/contour-isobands) crate (from [mthh/contour-isobands-rs](https://github.com/mthh/contour-isobands-rs) repository)
150+
While this crate computes isolines (cf. [wikipedia:Marching_squares](https://en.wikipedia.org/wiki/Marching_squares))
151+
and their corresponding polygons (i.e. polygons that contain all points above the threshold defined for a given isoline),
152+
[contour-isobands-rs](https://github.com/mthh/contour-isobands-rs) computes isobands (cf. [wikipedia:Marching_squares#Isobands](https://en.wikipedia.org/wiki/Marching_squares#Isobands))
153+
and their corresponding polygons (i.e. contour polygons that contain all points between a minimum and a maximum bound).
154+
155+
Depending on the desired use of the result, the [`contour-isobands`](https://crates.io/crates/contour-isobands) crate may be more suitable than this [`contour`](https://crates.io/crates/contour) crate.
156+
147157
## License
148158

149159
Licensed under either of
@@ -153,7 +163,7 @@ Licensed under either of
153163

154164
at your option.
155165

156-
### Contribution
166+
## Contribution
157167

158168
Unless you explicitly state otherwise, any contribution intentionally submitted
159169
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any

0 commit comments

Comments
 (0)