Skip to content

Commit

Permalink
update the top level documentation files
Browse files Browse the repository at this point in the history
- README has been added
- CHANGELOG/package.json have been changed to alpha release
  • Loading branch information
warm-coolguy committed Apr 26, 2024
1 parent a676f90 commit c6beefa
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 7 deletions.
8 changes: 2 additions & 6 deletions packages/plugins/Measure/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
# CHANGELOG

## unpublished
## 1.0.0-alpha.0

- Initial release.

## 1.0.0

Initial release.
Alpha release. This tool is ready for use in minimal clients or for expert users. For caveats, see the README file.
13 changes: 13 additions & 0 deletions packages/plugins/Measure/README.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion packages/plugins/Measure/package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down

0 comments on commit c6beefa

Please sign in to comment.