1
0
Fork 0
freesewing/packages/plugin-bundle/README.md

123 lines
5.1 KiB
Markdown
Raw Normal View History

> **Note**: This is part of version 2 of FreeSewing.
> It is a work in progress, and not ready for prime-time yet
>
> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).
<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>
<p align="center">FreeSewing is a free and open source library for made-to-measure sewing patterns</p>
<p align='center'><a
href="https://www.npmjs.com/package/@freesewing/plugin-bundle"
title="@freesewing/plugin-bundle on NPM"
><img src="https://badgen.net/npm/v/@freesewing/plugin-bundle"
alt="@freesewing/plugin-bundle on NPM"/>
</a><a
href="https://opensource.org/licenses/MIT"
title="License: MIT"
><img src="https://badgen.net/badge/License/MIT/blue"
alt="License: MIT"/>
</a></p><p align='center'><a
href="https://gitter.im/freesewing/freesewing"
title="Chat with us on Gitter"
><img src="https://badgen.net/badge//Chat/CA0547?icon=gitter"
alt="Chat with us on Gitter"/>
</a><a
href="https://twitter.com/freesewing_org"
title="Follow @freesewing_org on Twitter"
><img src="https://badgen.net/badge//@freesewing_org/1DA1F2?icon=twitter"
alt="Follow @freesewing_org on Twitter"/>
</a><a
href="https://github.com/freesewing"
title="FreeSewing on GitHub"
><img src="https://badgen.net/badge//freesewing/269F42?icon=github"
alt="FreeSewing on GitHub"/>
</a><a
href="https://freesewing.org/patrons/join"
title="Become a FreeSewing Patron"
><img src="https://badgen.net/badge/Become%20a/Patron/purple"
alt="Become a FreeSewing Patron"/>
</a></p>
# @freesewing/plugin-bundle
An umbrella package of 8 essential FreeSewing build-time plugins
2018-08-11 12:41:00 +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
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
import freesewing from '@freesewing/core'
import plugins from '@freesewing/plugin-bundle'
2018-08-11 12:41:00 +02:00
let pattern = new freesewing.Pattern().with(plugins);
2018-08-11 12:41:00 +02:00
```
## About FreeSewing 🤔
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.
## Support FreeSewing: Become a patron 🥰
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).
## Links 👩‍💻
- 💻 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)
## 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).