Document the NPM package now, and start a changelog. #150

a-b-street · Dec 10, 2022 · e1e01d2 · e1e01d2
1 parent 0870d40
commit e1e01d2
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -0,0 +1,7 @@
+# Changes
+
+## Unreleased
+
+## 0.1.0
+
+- Initial NPM package
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,6 +1,8 @@
 # Working on osm2streets
 
-Come hang out at https://github.com/a-b-street/osm2streets to ask questions and improve these docs.
+Come hang out at <https://github.com/a-b-street/osm2streets> to ask questions and improve these docs.
+
+Read [how it works](docs/how_it_works.md)
 
 ## Pre-requisites
 
@@ -13,6 +15,6 @@ See the `tests` crate [(docs)](tests/README.md) for a collection of interesting
 
 See `street-explorer` crate [(docs)](street-explorer/README.md) for a *Street Explorer* test browsing interface.
 
-## Design decisions
+## Developer notes
 
-The `Road` and `Intersection` structs are rather stateful. `trimmed_road_line` and `polygon` are derived state, produced by a transformation step. Derived state isn't updated automatically, so you have to be internally careful about knowing what transformations have run. Some earlier ones call `estimate_trimmed_geometry` for this reason.
+To release a new version of <https://www.npmjs.com/package/osm2streets-js>, bump the version number in `osm2streets-js/Cargo.toml` and run `wasm-pack publish`. By current permissions, only Dustin can run this, but we could add others.