VSinerva/freesewing
1
0
Fork 0
Code Activity

tada: First commit

Browse source
This commit is contained in:
Joost De Cock 2018-08-10 16:03:39 +02:00
parent 91b768a329
commit 4081cb91d6
9 changed files with 4989 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

59
packages/plugin-validate/README.md
View file

@ -1,2 +1,59 @@
<p align="center">
<a title="Go to freesewing.org" href="https://freesewing.org/"><img src="https://freesewing.org/img/logo/black.svg" align="center" width="150px" alt="Freesewing logo"/></a>
</p>
<h4 align="center"><em>&nbsp;<a title="Go to freesewing.org" href="https://freesewing.org/">freesewing</a></em>
<br><sup>a library for made-to-measure sewing patterns</sup>
</h4>
# plugin-validate
A freesewing plugin that checks whether all required measurements are set prior to drafting your pattern
A freesewing plugin that checks whether all required measurements are set prior to drafting your pattern.
If a measurement is missing, this will throw an exception, and tell you which measurement is missing.
## Usage
To load this plugin, add it to your instantiated pattern.
On node.js:
```js
import pattern from '@freesewing/pattern-brian'
import validate from '@freesewing/plugin-validate'
pattern.with(validate);
```
In the browser, this plugin will register as `freesewing.plugins.validate`:
```html
<script type="text/javascript" src="https://unpkg.com/freesewing"></script>
<script type="text/javascript" src="https://unpkg.com/@freesewing/plugin-validate"></script>
<script type="text/javascript" src="https://unpkg.com/@freesewing/pattern-brian"></script>
<script>
var pattern = freesewing.patterns.brian
.with(freesewing.plugins.validate);
</script>
```
## Install
To install, run:
```sh
npm install @freesewing/plugin-validate
```
## Build
To build this plugin, run:
```sh
npm run build
```
## License: MIT
See [the license file](https://github.com/freesewing/plugin-validate/blob/master/LICENSE)
for details.