Joost De Cock 1fd46554af 🔧 Switched to centrally managed README files

2019-04-19 20:09:30 +02:00

6 KiB

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

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

@freesewing/plugin-i18n

A FreeSewing plugin for pattern translation

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

plugin-i18n

A freesewing plugin to provide translation to your patterns.

Install

On node.js:

npm install @freesewing/plugin-i18n

in the browser, simply include the plugin from unpkg:

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

This plugin will register as freesewing.plugins.i18n.

Loading this plugin and providing translation data

This plugin does not come with translations. You should provide the translations when registering the plugin.

Perhaps you want to use your own translations, or you can use ours from the @freesewing/i18n package. Note that if you use ours, you only need to add the plugin export:

import brian from '@freesewing/brian';
import i18nPlugin from '@freesewing/plugin-grainline';
import { plugin } from '@freesewing/i18n';

const pattern = new Brian().with(i18nPlugin, {
  prefix: "plugin.",
  strings: plugin
});

Build

To build this plugin, run:

npm run build

License: MIT

See the license file for details.

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.

6 KiB Raw Blame History