History

Joost De Cock 1fd46554af 🔧 Switched to centrally managed README files		2019-04-19 20:09:30 +02:00
..
img	tada: First commit	2019-04-19 08:17:12 +02:00
src	sparkles: Added plugin-sprinkle	2019-04-19 08:17:13 +02:00
tests	wrench: Updated rollup config	2019-04-19 08:17:14 +02:00
.editorconfig	tada: First commit	2019-04-19 08:17:12 +02:00
.gitignore	tada: First commit	2019-04-19 08:17:12 +02:00
.npmignore	tada: First commit	2019-04-19 08:17:12 +02:00
.travis.yml	Merge branch 'master' of github.com:freesewing/plugin-bundle	2019-04-19 08:17:13 +02:00
info.md	🔧 Switched to centrally managed README files	2019-04-19 20:09:30 +02:00
package.json	🔧 Centrally confifured package and rollup files	2019-04-19 17:31:44 +02:00
README.md	🔧 Switched to centrally managed README files	2019-04-19 20:09:30 +02:00
rollup.config.js	🔧 Centrally confifured package and rollup files	2019-04-19 17:31:44 +02:00

README.md

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 hellp in our chatroom on Gitter.

FreeSewing is a free and open source library for made-to-measure sewing patterns

@freesewing/plugin-bundle

An umbrella package of 8 essential FreeSewing build-time plugins

freesewing
^{a library for made-to-measure sewing patterns}

plugin-bundle

A freesewing plugin that provides the following plugins in one bundle:

plugin-cutonfold : Add cut-on-fold indicators to your patterns
plugin-dimension : Add dimensions to your (paperless) patterns
plugin-grainline : Add grainline indicators to your patterns
plugin-logo : Add a scalebox to your patterns
plugin-scalebox : Add pretty titles to your pattern parts
plugin-title : Add pretty titles to your pattern parts
plugin-round : Rounds corners
plugin-sprinkle : Add multiple snippets to your pattern

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 plugins, so it made sense to bundle them.

Usage

To load this plugin, add it to your instantiated pattern.

On node.js:

import freesewing from 'freesewing'
import pluginBundle from '@freesewing/plugin-bundle'

let pattern = new freesewing.Pattern()
  .with(pluginBundle);

In the browser, this plugin will register as freesewing.plugins.bundle:

<script type="text/javascript" src="https://unpkg.com/freesewing"></script>
<script type="text/javascript" src="https://unpkg.com/@freesewing/plugin-bundle"></script>

<script>
var pattern = new freesewing.Pattern()
  .with(freesewing.plugins.bundle);
</script>

Install

To install, run:

npm install @freesewing/plugin-bundle

Build

To build this plugin, run:

npm run build

About FreeSewing

Where the world of makers and developers collide, that's where you'll find FreeSewing.

Our core library is a batteries-included toolbox for parametric design of sewing patterns. It's a modular system (check our list of plugins and getting started is as simple as:

npm init freesewing-pattern

The [getting started] section on freesewing.dev is a good entrypoint to our documentation, but you'll find a lot more there, including our API documentation, as well as examples, and best practices.

If you're a maker, checkout freesewing.org 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.