2019-04-19 20:09:30 +02:00
> **Note**: This is part of version 2 of FreeSewing.
> It is a work in progress, and not ready for prime-time yet
>
2019-04-19 20:48:29 +02:00
> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).
2019-04-19 20:09:30 +02:00
< p align = "center" > < a title = "Go to freesewing.org" href = "https://freesewing.org/" > < img src = "https://freesewing.org/img/logo/black.svg" align = "center" width = "150px" alt = "Freesewing logo" / > < / a > < / p >
2019-04-20 15:36:31 +02:00
< p align = "center" > FreeSewing is a free and open source library for made-to-measure sewing patterns< / p >
2019-04-19 20:48:29 +02:00
< p align = 'center' > < a
href="https://www.npmjs.com/package/@freesewing/plugin -bundle"
title="@freesewing/plugin -bundle on NPM"
2019-04-21 12:57:12 +02:00
>< img src = "https://img.shields.io/npm/v/freesewing.svg"
2019-04-19 20:48:29 +02:00
alt="@freesewing/plugin -bundle on NPM"/>
< / a > < a
href="https://opensource.org/licenses/MIT"
title="License: MIT"
2019-04-21 12:57:12 +02:00
>< img src = "https://img.shields.io/npm/l/freesewing.svg?label=License"
2019-04-19 20:48:29 +02:00
alt="License: MIT"/>
< / a > < a
2019-04-21 12:57:12 +02:00
href="https://github.com/freesewing/freesewing/issues?q=is%3Aissue+is%3Aopen+label%3Apkg%3Aplugin-bundle"
title="Open issues tagged pkg:plugin-bundle"
>< img src = "https://img.shields.io/github/issues/freesewing/freesewing/pkg:plugin-bundle.svg?label=Issues"
alt="Open issues tagged pkg:plugin-bundle"/>
< / a > < / p > < p align = 'center' > < a
2019-04-19 20:48:29 +02:00
href="https://twitter.com/freesewing_org"
title="Follow @freesewing_org on Twitter"
2019-04-21 12:57:12 +02:00
>< img src = "https://img.shields.io/badge/%F3%A0%80%A0-Follow%20us-blue.svg?logo=twitter&logoColor=white&logoWidth=15"
2019-04-19 20:48:29 +02:00
alt="Follow @freesewing_org on Twitter"/>
< / a > < a
2019-04-21 12:57:12 +02:00
href="https://gitter.im/freesewing/freesewing"
title="Chat with us on Gitter"
>< img src = "https://img.shields.io/badge/%F3%A0%80%A0-Chat%20with%20us-CA0547.svg?logo=gitter&logoColor=white&logoWidth=15"
alt="Chat with us on Gitter"/>
2019-04-19 20:48:29 +02:00
< / a > < a
href="https://freesewing.org/patrons/join"
title="Become a FreeSewing Patron"
2019-04-21 12:57:12 +02:00
>< img src = "https://img.shields.io/badge/%F3%A0%80%A0-Support%20us-blueviolet.svg?logo=cash-app&logoColor=white&logoWidth=15"
2019-04-19 20:48:29 +02:00
alt="Become a FreeSewing Patron"/>
2019-04-21 12:57:12 +02:00
< / a > < a
href="https://instagram.com/freesewing_org"
title="Follow @freesewing_org on Twitter"
>< img src = "https://img.shields.io/badge/%F3%A0%80%A0-Follow%20us-E4405F.svg?logo=instagram&logoColor=white&logoWidth=15"
alt="Follow @freesewing_org on Twitter"/>
2019-04-19 20:48:29 +02:00
< / a > < / p >
# @freesewing/plugin-bundle
2019-04-19 20:09:30 +02:00
An umbrella package of 8 essential FreeSewing build-time plugins
2018-08-11 12:41:00 +02:00
2019-04-19 20:48:29 +02:00
# Plugins
2018-08-11 12:41:00 +02:00
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
2018-08-20 14:17:19 +02:00
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
2019-04-13 15:56:33 +02:00
7) [plugin-round ](https://github.com/freesewing/plugin-title ) : Rounds corners
8) [plugin-sprinkle ](https://github.com/freesewing/plugin-sprinkle ) : Add multiple snippets to your pattern
2018-08-11 13:50:46 +02:00
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.
2018-08-20 14:17:19 +02:00
Without exception, all freesewing patterns use all these plugins, so it made sense to bundle them.
2018-08-11 13:50:46 +02:00
2018-08-11 12:41:00 +02:00
## Usage
To load this plugin, add it to your instantiated pattern.
On node.js:
```js
2019-04-19 20:48:29 +02:00
import freesewing from '@freesewing/core '
import plugins from '@freesewing/plugin -bundle'
2018-08-11 12:41:00 +02:00
2019-04-19 20:48:29 +02:00
let pattern = new freesewing.Pattern().with(plugins);
2018-08-11 12:41:00 +02:00
```
2019-04-19 20:09:30 +02:00
2019-04-19 20:48:29 +02:00
## About FreeSewing 🤔
2019-04-19 20:09:30 +02:00
Where the world of makers and developers collide, that's where you'll find FreeSewing.
Our [core library ](https://freesewing.dev/en/freesewing ) is a *batteries-included* toolbox
for parametric design of sewing patterns. It's a modular system (check our list
of [plugins ](https://freesewing.dev/en/plugins ) and getting started is as simple as:
```bash
npm init freesewing-pattern
```
The [getting started] section on [freesewing.dev ](https://freesewing.dev/ ) is a good
entrypoint to our documentation, but you'll find a lot more there, including
our [API documentation ](https://freesewing.dev/en/freesewing/api ),
as well as [examples ](https://freesewing.dev/en/freesewing/examples ),
and [best practices ](https://freesewing.dev/en/do ).
If you're a maker, checkout [freesewing.org ](https://freesewing/ ) where you can generate
our sewing patterns adapted to your measurements.
2019-04-19 20:48:29 +02:00
## Support FreeSewing: Become a patron 🥰
2019-04-19 20:09:30 +02:00
FreeSewing is an open source project run by a community,
and financially supported by our patrons.
If you feel what we do is worthwhile, you too
should [become a patron ](https://freesewing.org/patrons/join ).
2019-04-19 20:48:29 +02:00
## Links 👩💻
2019-04-19 20:09:30 +02:00
- 💻 Makers website: [freesewing.org ](https://freesewing.org )
- 💻 Developers website: [freesewing.dev ](https://freesewing.org )
- 💬 Chat: [gitter.im/freesewing ](https://gitter.im/freesewing/freesewing )
- 🐦 Twitter: [@freesewing_org ](https://twitter.com/freesewing_org )
- 📷 Instagram: [@freesewing_org ](https://instagram.com/freesewing_org )
2019-04-19 20:48:29 +02:00
## License: MIT 🤓
© [Joost De Cock ](https://github.com/joostdecock ).
See [the license file ](https://github.com/freesewing/freesewing/blob/develop/LICENSE ) for details.
## Where to get help 🤯
Our [chatroom on Gitter ](https://gitter.im ) is the best place to ask questions,
share your feedback, or just hang out.
If you want to report a problem, please [create an issue ](https://github.com/freesewing/freesewing/issues/new ).