diff --git a/packages/plugins/Measure/CHANGELOG.md b/packages/plugins/Measure/CHANGELOG.md index e02af2e6b..198a0075f 100644 --- a/packages/plugins/Measure/CHANGELOG.md +++ b/packages/plugins/Measure/CHANGELOG.md @@ -1,9 +1,5 @@ # CHANGELOG -## unpublished +## 1.0.0-alpha.0 -- Initial release. - -## 1.0.0 - -Initial release. \ No newline at end of file +Alpha release. This tool is ready for use in minimal clients or for expert users. For caveats, see the README file. diff --git a/packages/plugins/Measure/README.md b/packages/plugins/Measure/README.md index e69de29bb..43751b544 100644 --- a/packages/plugins/Measure/README.md +++ b/packages/plugins/Measure/README.md @@ -0,0 +1,13 @@ +# Measure + +## Scope + +The tool offers measuring distances and areas as multi-point lines and polygons. + +## Configuration + +There are currently no configurable parameters to this plugin. It always offers modes (Select/Draw/Edit/Delete), a switch to measure either distances or areas, a unit selection (m/km), and an RGB colour selection for text and lines displayed regarding measurements. + +## Caveats + +The tool is not yet configurable and may yield unexpected behaviour when used in combination with the plugins Draw and Pins, as some interactions do overlap. The colouring tool requires a basic understanding of RGB colour mixing. You can easily offer this tool to expert users, but it may confuse regular users. diff --git a/packages/plugins/Measure/package.json b/packages/plugins/Measure/package.json index 45819d43c..0d856aed0 100644 --- a/packages/plugins/Measure/package.json +++ b/packages/plugins/Measure/package.json @@ -1,6 +1,6 @@ { "name": "@polar/plugin-measure", - "version": "1.0.0", + "version": "1.0.0-alpha.0", "description": "Plugin Measure", "license": "EUPL-1.2", "type": "module",