1
0
Fork 0
freesewing/packages/plugin-buttons/README.md
2019-04-19 08:20:42 +02:00

2.3 KiB

Freesewing logo

 freesewing
a library for made-to-measure sewing patterns

Travis build Version License Code coverage DeepScan grade Chat on Gitter Become a Patron

plugin-buttons

A freesewing plugin that provides button and buttonhole snippets.

Install

Install this plugin from NPM:

npm install --save @freesewing/plugin-buttons

Usage

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

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

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

  return this;
}

You now have the button and buttonhole snippets available:

snippets.btn = new Snippet("button", points.buttonAnchor);
snippets.btnhole = new Snippet("buttonhole", points.buttonholeAnchor);

FIXME: Link to documentation

Where to get help

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