freesewing/packages/plugin-sprinkle/README.md

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

plugin-sprinkle

A freesewing plugin to bulk-add multiple snippets to your pattern.

Typically used to add a bunch of notches, buttons, and so on.

Install

Install this plugin from NPM:

npm install --save @freesewing/plugin-sprinkle

Usage

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

import freesewing from 'freesewing'
import sprinkle from '@freesewing/plugin-sprinkle'

const Simon = function(settings) {
  freesewing.Pattern.call(this, config);
  this
    .use(sprinkle)
    .apply(settings);

  return this;
}

You now have the sprinkle macro available:

macro("sprinkle", {
  snippet: "notch",
  on: ["pointA", "pointB", "pointC"]
});

FIXME: Link to documentation

Where to get help

Questions? Stuck? The freesewing chat room on Gitter is the best place to ask for help.