From e8d37842f4f62e2d31da61740c4c7aa9d875d12f Mon Sep 17 00:00:00 2001 From: Joost De Cock Date: Mon, 20 Aug 2018 14:17:19 +0200 Subject: [PATCH] pencil2: README update --- packages/plugin-bundle/README.md | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/packages/plugin-bundle/README.md b/packages/plugin-bundle/README.md index 037472db29c..79020f83880 100644 --- a/packages/plugin-bundle/README.md +++ b/packages/plugin-bundle/README.md @@ -19,13 +19,14 @@ A freesewing plugin that provides the following plugins in one bundle: 1) [plugin-cutonfold](https://github.com/freesewing/plugin-cutonfold) : Add cut-on-fold indicators to your patterns 2) [plugin-dimension](https://github.com/freesewing/plugin-dimension) : Add dimensions to your (paperless) patterns 3) [plugin-grainline](https://github.com/freesewing/plugin-grainline) : Add grainline indicators to your patterns - 4) [plugin-logo](https://github.com/freesewing/plugin-logo) : Add our logo to your patterns - 5) [plugin-title](https://github.com/freesewing/plugin-title) : Add pretty titles to your pattern parts + 4) [plugin-logo](https://github.com/freesewing/plugin-logo) : Add a scalebox to your patterns + 5) [plugin-scalebox](https://github.com/freesewing/plugin-scalebox) : Add pretty titles to your pattern parts + 6) [plugin-title](https://github.com/freesewing/plugin-title) : Add pretty titles to your pattern parts Note that these are all **build-time plugins**. In other words, plugins used by developers/pattern designers, rather than run-time plugins that are used when generating patterns. -Without exception, all freesewing patterns use all these 5 plugins, so it made sense to bundle them. +Without exception, all freesewing patterns use all these plugins, so it made sense to bundle them. ## Usage @@ -34,10 +35,11 @@ To load this plugin, add it to your instantiated pattern. On node.js: ```js -import pattern from '@freesewing/brian' +import freesewing from 'freesewing' import pluginBundle from '@freesewing/plugin-bundle' -pattern.with(pluginBundle); +let pattern = new freesewing.Pattern() + .with(pluginBundle); ``` In the browser, this plugin will register as `freesewing.plugins.bundle`: @@ -45,10 +47,9 @@ In the browser, this plugin will register as `freesewing.plugins.bundle`: ```html - ``` @@ -68,8 +69,3 @@ To build this plugin, run: ```sh npm run build ``` - -## License: MIT - -See [the license file](https://github.com/freesewing/plugin-theme/blob/master/LICENSE) -for details.