1
0
Fork 0

pencil2: Readme update

This commit is contained in:
Joost De Cock 2018-08-09 18:29:04 +02:00
parent b209c264fb
commit 8ce40de9e3
2 changed files with 92 additions and 55 deletions

View file

@ -1,3 +1,10 @@
<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>
# Models
A set of body measurement data for a range of standard models/sizes.
@ -9,6 +16,8 @@ npm install --save @freesewing/models
## Usage
In node.js:
```js
import { manSize38 } from @freesewing/models
```
@ -30,6 +39,20 @@ The example above gives you:
wristCircumference: 185
}
```
In the browser, this will register as `freesewing.models`:
```html
<script type="text/javascript" src="https://unpkg.com/freesewing"></script>
<script type="text/javascript" src="https://unpkg.com/@freesewing/models"></script>
<script type="text/javascript" src="https://unpkg.com/@freesewing/pattern-brian"></script>
<script>
var pattern = freesewing.patterns.brian;
pattern.settings.measurements = freesewing.models.manSize38;
</script>
```
## Units
All measurements are in mm.
@ -42,3 +65,17 @@ All measurements are in mm.
- manSize40
- manSize42
- manSize44
## Build
To build this, run:
```sh
npm run build
```
## License: MIT
See [the license file](https://github.com/freesewing/plugin-theme/blob/master/LICENSE)
for details.

View file

@ -71,4 +71,4 @@ module.exports = {
shoulderToWrist: 700,
wristCircumference: 200
}
}
};