🔧 Changes badges layout in READMEs
This commit is contained in:
Joost De Cock
parent
1fd46554af
commit
51e3aa83ce
74 changed files with 2265 additions and 2352 deletions
|
|
@ -1,76 +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>
|
||||
|
||||
# @freesewing/components
|
||||
|
||||
A collection of React components for FreeSewing web UIs
|
||||
|
||||
<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> <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://www.npmjs.com/package/@freesewing/components"><img src="https://badgen.net/npm/v/@freesewing/components" alt="Version"></a>
|
||||
<a href="https://www.npmjs.com/package/@freesewing/components"><img src="https://badgen.net/npm/license/@freesewing/components" alt="License"></a>
|
||||
<a href="https://deepscan.io/dashboard#view=project&tid=2114&pid=4633&bid=37171"><img src="https://deepscan.io/api/teams/2114/projects/4633/branches/37171/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>
|
||||
<p align='center'><a
|
||||
href="https://www.npmjs.com/package/@freesewing/components"
|
||||
title="@freesewing/components on NPM"
|
||||
><img src="https://badgen.net/npm/v/@freesewing/components"
|
||||
alt="@freesewing/components 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/components
|
||||
|
||||
This is a [Material UI](https://material-ui.com) theme that's used by the freesewing web sites.
|
||||
A collection of React components for FreeSewing web UIs
|
||||
|
||||
|
||||
## Install
|
||||
|
||||
```
|
||||
npm i --save @freesewing/components
|
||||
```
|
||||
|
||||
## Getting the theme
|
||||
|
||||
After installing [@freesewing/components](https://www.npmjs.com/package/@freesewing/components),
|
||||
import it:
|
||||
|
||||
```js
|
||||
import createTheme from "@freesewing/components";
|
||||
```
|
||||
|
||||
The default export (`createTheme` in our example above) is a method that
|
||||
calls [`createMuiTheme`](https://material-ui.com/customization/themes/#createmuitheme-options-theme) under the hood.
|
||||
It takes a single argument, the theme name:
|
||||
|
||||
```
|
||||
object createTheme(string themeName = "light")
|
||||
```
|
||||
|
||||
If the name you pass it is `dark` you'll get the dark theme.
|
||||
Anything else, and you'll get the light theme.
|
||||
|
||||
## Using the theme
|
||||
|
||||
To use this theme, you need to pass it as the `theme` prop to
|
||||
[`muiThemeProvider`](https://material-ui.com/customization/themes/#muithemeprovider):
|
||||
|
||||
```js
|
||||
<MuiThemeProvider theme={createTheme(true)}>
|
||||
// ... your app here
|
||||
</MuiThemeProvider>
|
||||
```
|
||||
|
||||
See [the Material-UI docs on themes](https://material-ui.com/customization/themes/) for more details.
|
||||
|
||||
|
||||
## About FreeSewing
|
||||
## About FreeSewing 🤔
|
||||
|
||||
Where the world of makers and developers collide, that's where you'll find FreeSewing.
|
||||
|
||||
|
|
@ -91,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.
|
||||
|
|
@ -99,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).
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue