1
0
Fork 0
freesewing/packages/plugin-title/README.md
2019-04-19 08:23:00 +02:00

1.7 KiB

Freesewing logo

 freesewing
a library for made-to-measure sewing patterns

plugin-title

A freesewing plugin to add pretty part titles to your pattern.

Usage

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

On node.js:

import pattern from '@freesewing/pattern-brian'
import title from '@freesewing/plugin-theme'
import title from '@freesewing/plugin-title'

pattern..with(theme).with(title);

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

<script type="text/javascript" src="https://unpkg.com/freesewing"></script>
<script type="text/javascript" src="https://unpkg.com/@freesewing/pattern-brian"></script>
<script type="text/javascript" src="https://unpkg.com/@freesewing/plugin-theme"></script>
<script type="text/javascript" src="https://unpkg.com/@freesewing/plugin-title"></script>

<script>
var pattern = freesewing.patterns.brian
  .with(freesewing.plugins.theme)
  .with(freesewing.plugins.title);
</script>

Example

This plugin styles a title like this:

Example of the title inserted by this plugin

Install

To install, run:

npm install @freesewing/plugin-title

Build

To build this plugin, run:

npm run build

License: MIT

See the license file for details.