VSinerva/freesewing
1
0
Fork 0
Code Activity

pencil2: README udate

Browse source
This commit is contained in:
joostdecock 2018-09-26 12:19:35 +00:00 • committed by Joost De Cock
parent 1fb76f39c7
commit 8977f68677
1 changed files with 10 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

27
packages/plugin-theme/README.md
View file

@ -4,10 +4,19 @@
<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>
<p align="center">
<a href="https://travis-ci.org/freesewing/plugin-theme"><img src="https://badgen.net/travis/freesewing/plugin-theme/master" alt="Travis build"></a>
<a href="https://www.npmjs.com/package/@freesewing/plugin-theme"><img src="https://badgen.net/npm/v/@freesewing/plugin-theme" alt="Version"></a>
<a href="https://www.npmjs.com/package/@freesewing/plugin-theme"><img src="https://badgen.net/npm/license/@freesewing/plugin-theme" alt="License"></a>
<a href="https://codecov.io/gh/freesewing/plugin-theme"><img src="https://badgen.net/codecov/c/github/freesewing/plugin-theme/master" alt="Code coverage"></a>
<a href="https://deepscan.io/dashboard#view=project&pid=3270&bid=27577"><img src="https://deepscan.io/api/projects/3270/branches/27577/badge/grade.svg" alt="DeepScan grade"></a>
<a href="https://gitter.im/freesewing/freesewing"><img src="https://badgen.net/badge/chat/on%20Gitter/cyan" alt="Chat on Gitter"></a>
<a href="https://freesewing.org/patrons/join"><img src="https://badgen.net/badge/become/a%20Patron/FF5B77" alt="Become a Patron"></a>
</p>
# plugin-theme
A freesewing plugin to provide styles for freesewing. This plugin also provides the `notch` snippet.
A freesewing plugin that styles your patterns. This plugin also provides the `notch` and `bnotch` snippets.
## Usage
@ -35,14 +44,6 @@ var pattern = freesewing.patterns.brian
</script>
```
## Example
This plugin adds the following CSS classes to your SVG file:
![Example of the style provided by this theme](https://github.com/freesewing/plugin-theme/raw/master/img/example.png)
In addition, it adds the `notch` and `bnotch` snippets to your SVG file's defs section.
## Install
To install, run:
@ -51,14 +52,6 @@ To install, run:
npm install @freesewing/plugin-theme
```
## 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)