@abidibo/react-cam-roi 0.1.0 → 0.2.1

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/README.md +14 -14
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -5,7 +5,7 @@
5
5
  This is a react component which lets you draw regions of interest (ROI) over images, manage metadata and import/export everything.
6
6
  Metadata are dynamic information that can be attached to the whole image and/or to each ROI. The number of drawable ROIs can also be configured.
7
7
 
8
- ![Screenshot](./react-cam-roi.png)
8
+ ![Screenshot](./react-cam-roi-s.png)
9
9
 
10
10
  It provides one component: `RoiEditor` and one provider: `UiProvider`. The editor lets you draw regions of interest over a given image (url). Each ROI can have dynamic metadata attached.
11
11
 
@@ -647,11 +647,17 @@ type INotify = { // compatible with toast (react-toastify)
647
647
 
648
648
  There are components that cannot be overridden. But still you can use classes to style them.
649
649
 
650
- #### Wrapper
650
+ #### Top bar
651
651
 
652
- - `react-cam-roi-editor-wrapper`
653
- - `react-cam-roi-editor-wrapper-light`
654
- - `react-cam-roi-editor-wrapper-dark`
652
+ - `react-cam-roi-top-bar`
653
+ - `react-cam-roi-top-bar-light`
654
+ - `react-cam-roi-top-bar-dark`
655
+
656
+ #### Canvas wrapper
657
+
658
+ - `react-cam-roi-canvas-wrapper`
659
+ - `react-cam-roi-canvas-wrapper-light`
660
+ - `react-cam-roi-canvas-wrapper-dark`
655
661
 
656
662
  #### Header
657
663
 
@@ -730,12 +736,6 @@ Then rebuild this library to see your changes in the project.
730
736
 
731
737
  ## CI
732
738
 
733
- A github action pipeline is provided, it will publish the package to npm when a new tag is pushed. You need to add the `NPM_TOKEN` secret to your repository settings.
734
-
735
- Example of deployment:
736
-
737
- ```bash
738
- $ npm version patch
739
- $ git push
740
- $ git push --tags
741
- ```
739
+ A github action pipeline is provided, which is triggered by every push to the main branch.
740
+ The pipeline will publish the package to npm and update the CHANGELOG following the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/).
741
+ You need to add the `NODE_AUTH_TOKEN` and `GH_TOKEN` secrets to your repository settings, see [semantic-release](https://github.com/semantic-release/semantic-release) for more information.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@abidibo/react-cam-roi",
3
- "version": "0.1.0",
3
+ "version": "0.2.1",
4
4
  "description": "A react component for drawing ROI over images and managing metadata",
5
5
  "repository": {
6
6
  "type": "git",