@erase2d/fabric 1.1.8 → 1.1.9

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.
package/README.md CHANGED
@@ -24,10 +24,22 @@ object.clipPath instanceof ClippingGroup
24
24
  : delete object.clipPath;
25
25
  ```
26
26
 
27
+ ### Type Caveat
28
+
29
+ The `erasable` property is added by this module.
30
+ In case typescript fails to augment fabric, update your `tsconfig.ts`:
31
+
32
+ ```json
33
+ ...
34
+ "compilerOptions": {
35
+ "types": ["node_modules/@erase2d/fabric/types"]
36
+ }
37
+ ```
38
+
27
39
  ## Quick Start
28
40
 
29
41
  ```bash
30
- npm i fabric@beta @erase2d/fabric --save
42
+ npm i fabric @erase2d/fabric --save
31
43
  ```
32
44
 
33
45
  ```typescript
@@ -61,6 +73,8 @@ canvas.freeDrawingBrush = eraser;
61
73
  canvas.isDrawingMode = true;
62
74
  ```
63
75
 
76
+ Refer to the [example app](../app/pages/index.tsx) for in depth usage.
77
+
64
78
  ## Sponsors
65
79
 
66
80
  <table>