VSinerva/freesewing
1
0
Fork 0
Code Activity

pencil2: README update

Browse source
This commit is contained in:
Joost De Cock 2018-08-20 14:17:19 +02:00
parent 62cbcb0f05
commit e8d37842f4
1 changed files with 8 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

20
packages/plugin-bundle/README.md
View file

@ -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 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 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 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 4) [plugin-logo](https://github.com/freesewing/plugin-logo) : Add a scalebox to your patterns
5) [plugin-title](https://github.com/freesewing/plugin-title) : Add pretty titles to your pattern parts 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, 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. 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 ## Usage
@ -34,10 +35,11 @@ To load this plugin, add it to your instantiated pattern.
On node.js: On node.js:
```js ```js
import pattern from '@freesewing/brian' import freesewing from 'freesewing'
import pluginBundle from '@freesewing/plugin-bundle' 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`: 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 ```html
<script type="text/javascript" src="https://unpkg.com/freesewing"></script> <script type="text/javascript" src="https://unpkg.com/freesewing"></script>
<script type="text/javascript" src="https://unpkg.com/@freesewing/plugin-bundle"></script> <script type="text/javascript" src="https://unpkg.com/@freesewing/plugin-bundle"></script>
<script type="text/javascript" src="https://unpkg.com/@freesewing/brian"></script>
<script> <script>
var pattern = freesewing.patterns.brian var pattern = new freesewing.Pattern()
.with(freesewing.plugins.bundle); .with(freesewing.plugins.bundle);
</script> </script>
``` ```
@ -68,8 +69,3 @@ To build this plugin, run:
```sh ```sh
npm run build npm run build
``` ```
## License: MIT
See [the license file](https://github.com/freesewing/plugin-theme/blob/master/LICENSE)
for details.