1
0
Fork 0
freesewing/packages/i18n/README.md

155 lines
5.4 KiB
Markdown
Raw Normal View History

2019-05-10 15:17:31 +02:00
<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>
<br>
<a href="https://freesewing.org/">FreeSewing v2</a>
</p>
2019-08-25 17:23:14 +02:00
<p align="center">An open source platform for made-to-measure sewing patterns</p>
<p align='center'><a
href="https://www.npmjs.com/package/@freesewing/i18n"
title="@freesewing/i18n on NPM"
2019-05-10 15:08:07 +02:00
><img src="https://img.shields.io/npm/v/@freesewing/i18n.svg"
alt="@freesewing/i18n on NPM"/>
</a><a
href="https://opensource.org/licenses/MIT"
title="License: MIT"
2019-05-10 15:08:07 +02:00
><img src="https://img.shields.io/npm/l/@freesewing/i18n.svg?label=License"
alt="License: MIT"/>
</a><a
2019-05-10 15:17:31 +02:00
href="https://deepscan.io/dashboard#view=project&tid=2114&pid=2993&bid=23256"
title="Code quality on DeepScan"
><img src="https://deepscan.io/api/teams/2114/projects/2993/branches/23256/badge/grade.svg"
alt="Code quality on DeepScan"/>
</a><a
2019-04-21 12:57:12 +02:00
href="https://github.com/freesewing/freesewing/issues?q=is%3Aissue+is%3Aopen+label%3Apkg%3Ai18n"
title="Open issues tagged pkg:i18n"
><img src="https://img.shields.io/github/issues/freesewing/freesewing/pkg:i18n.svg?label=Issues"
alt="Open issues tagged pkg:i18n"/>
</a></p><p align='center'><a
href="https://twitter.com/freesewing_org"
title="Follow @freesewing_org on Twitter"
2019-04-21 12:57:12 +02:00
><img src="https://img.shields.io/badge/%F3%A0%80%A0-Follow%20us-blue.svg?logo=twitter&logoColor=white&logoWidth=15"
alt="Follow @freesewing_org on Twitter"/>
</a><a
2019-08-13 18:58:53 +02:00
href="https://gitter.im/freesewing/chat"
2019-04-21 12:57:12 +02:00
title="Chat with us on Gitter"
><img src="https://img.shields.io/badge/%F3%A0%80%A0-Chat%20with%20us-CA0547.svg?logo=gitter&logoColor=white&logoWidth=15"
alt="Chat with us on Gitter"/>
</a><a
href="https://freesewing.org/patrons/join"
title="Become a FreeSewing Patron"
2019-04-21 12:57:12 +02:00
><img src="https://img.shields.io/badge/%F3%A0%80%A0-Support%20us-blueviolet.svg?logo=cash-app&logoColor=white&logoWidth=15"
alt="Become a FreeSewing Patron"/>
2019-04-21 12:57:12 +02:00
</a><a
href="https://instagram.com/freesewing_org"
title="Follow @freesewing_org on Twitter"
><img src="https://img.shields.io/badge/%F3%A0%80%A0-Follow%20us-E4405F.svg?logo=instagram&logoColor=white&logoWidth=15"
alt="Follow @freesewing_org on Twitter"/>
</a></p>
# @freesewing/i18n
Translations for the FreeSewing project
# Languages
2018-11-22 16:06:17 +01:00
We currently provide translation in 5 languages:
2018-11-22 16:06:17 +01:00
- English
- German
- Spanish
- French
- Dutch
2018-11-22 16:06:17 +01:00
2018-11-24 14:20:57 +01:00
## How to use these translations
We use these translations in our [website repository](https://github.com/freesewing/website) to
translate react components with [react-intl](https://github.com/yahoo/react-intl):
```js
import { strings } from "@freesewing/i18n";
import { IntlProvider } from "react-intl";
class Base extends React.Component {
render() {
const { language } = this.props;
return (
<IntlProvider locale={language} messages={strings[language]}>
{...children}
</IntlProvier>
)
}
}
```
Now all components below will be able to translate messages:
```js
import React from "react";
import { FormattedMessage } from "react-intl";
const Example = props => {
return <p><FormattedMessage id={"app.aboutFreesewing"} /></p>
};
export default Example;
```
For all details, please refer to
[the react-intl documentation](https://github.com/yahoo/react-intl/wiki).
We also use it in our [backend repository](https://github.com/freesewing/website)
to translate the emails we send out to users.
## 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)
2019-08-13 18:58:53 +02:00
- 💬 Chat: [gitter.im/freesewing](https://gitter.im/freesewing/chat)
- 🐦 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 🤯
2019-08-13 18:58:53 +02:00
Our [chatroom on Gitter](https://gitter.im/freesewing/chat) 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).