VSinerva/freesewing
1
0
Fork 0
Code Activity

🔧 Changes badges layout in READMEs

Browse source
This commit is contained in:
Joost De Cock 2019-04-19 20:48:29 +02:00
parent 1fd46554af
commit 51e3aa83ce
74 changed files with 2265 additions and 2352 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,88 +1,49 @@
> **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/).
> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).
<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>
<p>FreeSewing is a free and open source library for made-to-measure sewing patterns</p>
<p align="center"><a href="https://gitter.im/freesewing/freesewing" title="Chat with us on Gitter"><img src="https://badgen.net/badge/Gitter/Chat%20with%20us/CA0547?icon=gitter" alt="Chat with us on Gitter"/></a><a href="https://twitter.com/freesewing_org" title="Follow @freesewing_org on Twitter"><img src="https://badgen.net/badge/Twitter/@freesewing_org/1DA1F2?icon=twitter" alt="Follow @freesewing_org on Twitter"/></a><a href="https://github.com/freesewing" title="FreeSewing on GitHub"><img src="https://badgen.net/badge/GitHub/freesewing/269F42?icon=github" alt="FreeSewing on GitHub"/></a><a href="https://freesewing.org/patrons/join" title="Become a FreeSewing Patron"><img src="https://badgen.net/badge/Become%20a/Patron/purple" alt="Become a FreeSewing Patron"/></a><a href="https://opensource.org/licenses/MIT" title="License: MIT"><img src="https://badgen.net/badge/License/MIT/blue" alt="License: MIT"/></a><a href="https://freesewing.org/patrons/join" title="Become a FreeSewing Patron"><img src="https://badgen.net/badge/Become%20a/Patron/purple" alt="Become a FreeSewing Patron"/></a><a href="https://freesewing.org/" title="FreeSewing.org"><img src="https://badgen.net/badge/FreeSewing/.org/3DA639" alt="FreeSewing.org"/></a><a href="https://freesewing.dev/" title="FreeSewing.dev"><img src="https://badgen.net/badge/FreeSewing/.dev/3DA639" alt="FreeSewing.dev"/></a></p>
<p align='center'><a
href="https://www.npmjs.com/package/@freesewing/plugin-validate"
title="@freesewing/plugin-validate on NPM"
><img src="https://badgen.net/npm/v/@freesewing/plugin-validate"
alt="@freesewing/plugin-validate on NPM"/>
</a><a
href="https://opensource.org/licenses/MIT"
title="License: MIT"
><img src="https://badgen.net/badge/License/MIT/blue"
alt="License: MIT"/>
</a></p><p align='center'><a
href="https://gitter.im/freesewing/freesewing"
title="Chat with us on Gitter"
><img src="https://badgen.net/badge//Chat/CA0547?icon=gitter"
alt="Chat with us on Gitter"/>
</a><a
href="https://twitter.com/freesewing_org"
title="Follow @freesewing_org on Twitter"
><img src="https://badgen.net/badge//@freesewing_org/1DA1F2?icon=twitter"
alt="Follow @freesewing_org on Twitter"/>
</a><a
href="https://github.com/freesewing"
title="FreeSewing on GitHub"
><img src="https://badgen.net/badge//freesewing/269F42?icon=github"
alt="FreeSewing on GitHub"/>
</a><a
href="https://freesewing.org/patrons/join"
title="Become a FreeSewing Patron"
><img src="https://badgen.net/badge/Become%20a/Patron/purple"
alt="Become a FreeSewing Patron"/>
</a></p>
# @freesewing&#x2F;plugin-validate
# @freesewing/plugin-validate
A FreeSewing plugin that validates aspects of your code
<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>
<p align="center">
<a href="https://travis-ci.org/freesewing/plugin-validate"><img src="https://badgen.net/travis/freesewing/plugin-validate/master" alt="Travis build"></a>
<a href="https://www.npmjs.com/package/@freesewing/plugin-validate"><img src="https://badgen.net/npm/v/@freesewing/plugin-validate" alt="Version"></a>
<a href="https://www.npmjs.com/package/@freesewing/plugin-validate"><img src="https://badgen.net/npm/license/@freesewing/plugin-validate" alt="License"></a>
<a href="https://codecov.io/gh/freesewing/plugin-validate"><img src="https://badgen.net/codecov/c/github/freesewing/plugin-validate/master" alt="Code coverage"></a>
<a href="https://deepscan.io/dashboard#view=project&pid=3286&bid=28006"><img src="https://deepscan.io/api/projects/3286/branches/28006/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-validate
A freesewing plugin that validates your pattern and input. It will check for:
- Missing measurements that are required by the pattern
- Missing X or Y coordinates in points
- Points that aren't points or don't have proper attributes
- Paths that don't do anything (no ops)
- Paths that use points that aren't valid points
- Text that will cause problems for translation
On any of these, this plugin will throw an error.
As such, it's not meant to be used in production, but rather during pattern
development, to spot issues in your code.
## 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
```
## License: MIT
See [the license file](https://github.com/freesewing/plugin-validate/blob/master/LICENSE)
for details.
## About FreeSewing
## About FreeSewing 🤔
Where the world of makers and developers collide, that's where you'll find FreeSewing.
@ -103,7 +64,7 @@ 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 ♥️
## Support FreeSewing: Become a patron 🥰
FreeSewing is an open source project run by a community,
and financially supported by our patrons.
@ -111,10 +72,22 @@ 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
## 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)
## License: MIT 🤓
© [Joost De Cock](https://github.com/joostdecock).
See [the license file](https://github.com/freesewing/freesewing/blob/develop/LICENSE) for details.
## Where to get help 🤯
Our [chatroom on Gitter](https://gitter.im) is the best place to ask questions,
share your feedback, or just hang out.
If you want to report a problem, please [create an issue](https://github.com/freesewing/freesewing/issues/new).