js-draw 1.0.0 → 1.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Henry Heino
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,6 +1,6 @@
 # js-draw
 
-[NPM package](https://www.npmjs.com/package/js-draw) | [GitHub](https://github.com/personalizedrefrigerator/js-draw) | [Documentation](https://personalizedrefrigerator.github.io/js-draw/typedoc/modules/lib.html) | [Try it!](https://personalizedrefrigerator.github.io/js-draw/example/example.html)
+[NPM package](https://www.npmjs.com/package/js-draw) | [GitHub](https://github.com/personalizedrefrigerator/js-draw) | [Documentation](https://personalizedrefrigerator.github.io/js-draw/typedoc/) | [Try it!](https://personalizedrefrigerator.github.io/js-draw/example/example.html)
 
 ![](docs/img/readme-images/js-draw.jpg)
 
@@ -42,7 +42,7 @@ const editor = new Editor(document.body);
 If you're not using a bundler, consider using the pre-bundled editor:
 ```html
 <!-- Replace 0.20.0 with the latest version of js-draw -->
-<script src="https://cdn.jsdelivr.net/npm/js-draw@0.20.0/dist/bundle.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/js-draw@1.0.0/dist/bundle.js"></script>
 <script>
     const editor = new jsdraw.Editor(document.body);
     editor.addToolbar();
@@ -60,20 +60,34 @@ To create a toolbar with the default tools:
 const toolbar = editor.addToolbar();
 ```
 
-Custom actions can be added to the toolbar. For example, to add a `save` button:
+Save and exit buttons can be added with the `.addSaveButton` and `.addExitButton` methods: 
 ```ts
-toolbar.addActionButton('Save', () => {
+toolbar.addSaveButton(() => {
     const svgElem = editor.toSVG();
     console.log('The saved SVG:', svgElem.outerHTML);
 });
+
+toolbar.addExitButton(() => {
+    // Save here?
+
+    // Removes the editor from the document.
+    editor.remove();
+});
+```
+
+Custom actions can also be added to the toolbar. For example,
+```ts
+toolbar.addActionButton('Custom', () => {
+    // When the action button is pressed
+});
 ```
 or alternatively, with an icon,
 ```ts
 toolbar.addActionButton({
-  label: 'Save'
+  label: 'Custom',
   icon: editor.icons.makeSaveIcon(),
 }, () => {
-    // Save content here.
+    // Do something here
 });
 ```