@planet/maps 8.1.0-dev.1693235943382 → 8.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/readme.md +8 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@planet/maps",
3
- "version": "8.1.0-dev.1693235943382",
3
+ "version": "8.2.0",
4
4
  "description": "Declarative mapping components for React",
5
5
  "type": "module",
6
6
  "scripts": {
package/readme.md CHANGED
@@ -73,6 +73,14 @@ After updating the `ol` package to a new version, the generated component source
73
73
  npm run generate
74
74
  ```
75
75
 
76
+ To publish a new release, choose the release type, update the `package.json` version and create a tag with `npm version`, and then push the change:
77
+ ```bash
78
+ npm version minor
79
+ git push --tags origin main
80
+ ```
81
+
82
+ After pushing the changes, draft release notes based on the tag and publish the [GitHub release](https://github.com/planetlabs/maps/releases).
83
+
76
84
  ## Prior Art
77
85
 
78
86
  Other projects like [`react-openlayers-fiber`](https://github.com/crubier/react-openlayers-fiber) and [`react-ol-fiber`](https://www.npmjs.com/package/react-ol-fiber) use a similar approach and provided inspiration for this project. The major difference between this project and those is that this project provides importable components for OpenLayers layers, sources, controls, and interactions. The other projects bundle all of OpenLayers in their renderer. So a simple "hello world" map with one of the existing projects is about 1.5 MB while the same with this project is about 460 KB.