> **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](https://gitter.im/).
FreeSewing is a free and open source library for made-to-measure sewing patterns
# @freesewing/plugin-grainline
A FreeSewing plugin to add grainline indicators on your patterns
freesewing
a library for made-to-measure sewing patterns
# plugin-grainline
A freesewing plugin to add grainline indicators to your patterns.
## Install
On node.js:
```sh
npm install @freesewing/plugin-grainline
```
in the browser, simply include this script:
```html
```
## Loading this plugin
To load this plugin, add it to your instantiated pattern.
On node.js:
```js
import pattern from '@freesewing/pattern-brian'
import grainline from '@freesewing/plugin-grainline'
pattern.with(grainline);
```
In the browser, this plugin will register as `freesewing.plugins.grainline`.
Since it's a build-time plugin, it will be loaded by the pattern.
```html
```
## Usage
This plugin provides the `grainline` macro.
> The macro method is available from the `shorthand()` method on an instantiated pattern part.
```js
macro('grainline', {
from: points.cbNeck
, to: points.cbHips
});
```
### Parameters
- `to`: A point object at the start of the grainline indicator
- `from`: A point object at the end of the grainline indicator
As all freesewing macros, bundle these parameters into a single object.
## Example
## Build
To build this plugin, run:
```sh
npm run build
```
## License: MIT
See [the license file](https://github.com/freesewing/plugin-theme/blob/master/LICENSE)
for details.
## About FreeSewing
Where the world of makers and developers collide, that's where you'll find FreeSewing.
Our [core library](https://freesewing.dev/en/freesewing) is a *batteries-included* toolbox
for parametric design of sewing patterns. It's a modular system (check our list
of [plugins](https://freesewing.dev/en/plugins) and getting started is as simple as:
```bash
npm init freesewing-pattern
```
The [getting started] section on [freesewing.dev](https://freesewing.dev/) is a good
entrypoint to our documentation, but you'll find a lot more there, including
our [API documentation](https://freesewing.dev/en/freesewing/api),
as well as [examples](https://freesewing.dev/en/freesewing/examples),
and [best practices](https://freesewing.dev/en/do).
If you're a maker, checkout [freesewing.org](https://freesewing/) 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](https://freesewing.org/patrons/join).
## Links
- 💻 Makers website: [freesewing.org](https://freesewing.org)
- 💻 Developers website: [freesewing.dev](https://freesewing.org)
- 💬 Chat: [gitter.im/freesewing](https://gitter.im/freesewing/freesewing)
- 🐦 Twitter: [@freesewing_org](https://twitter.com/freesewing_org)
- 📷 Instagram: [@freesewing_org](https://instagram.com/freesewing_org)