https://github.com/hfreire/native-speaker

A modern language :cn: :us: localisation library built on top of i18n
https://github.com/hfreire/native-speaker

github-actions i18n language locale localization translation

Last synced: 20 days ago
JSON representation

A modern language :cn: :us: localisation library built on top of i18n

• Host: GitHub
• URL: https://github.com/hfreire/native-speaker
• Owner: hfreire
• License: mit
• Created: 2017-04-02T15:11:50.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-09-07T08:24:16.000Z (2 months ago)
• Last Synced: 2024-10-13T09:16:03.636Z (about 1 month ago)
• Topics: github-actions, i18n, language, locale, localization, translation
• Language: JavaScript
• Size: 2.62 MB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 29
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# A modern language :cn: :us: localisation library built on top of i18n

[![](https://github.com/hfreire/native-speaker/workflows/ci/badge.svg)](https://github.com/hfreire/native-speaker/actions?workflow=ci)

[![Coverage Status](https://coveralls.io/repos/github/hfreire/native-speaker/badge.svg?branch=master)](https://coveralls.io/github/hfreire/native-speaker?branch=master)

[![Known Vulnerabilities](https://snyk.io/test/github/hfreire/native-speaker/badge.svg)](https://snyk.io/test/github/hfreire/native-speaker)

[![](https://img.shields.io/github/release/hfreire/native-speaker.svg)](https://github.com/hfreire/native-speaker/releases)

[![Version](https://img.shields.io/npm/v/native-speaker.svg)](https://www.npmjs.com/package/native-speaker)

[![Downloads](https://img.shields.io/npm/dt/native-speaker.svg)](https://www.npmjs.com/package/native-speaker)

> A modern language :cn: :us: localisation library built on top of i18n

### Features

* Supports multiple randomly picked message localisations :white_check_mark:

### How to install

```

npm install native-speaker

```

### How to use

#### Use it in your app

```javascript

const Locale = require('native-speaker')

const message = Locale.get('en', 'hello_world')

```

#### Available environment variables

Variable | Description | Required | Default value

:---:|:---:|:---:|:---:

DEFAULT_LOCALE | The locale to be used when the desired locale is not available. | false | `en`

### How to contribute

You can contribute either with code (e.g., new features, bug fixes and documentation) or by [donating 5 EUR](https://paypal.me/hfreire/5). You can read the [contributing guidelines](CONTRIBUTING.md) for instructions on how to contribute with code.

All donation proceedings will go to the [Sverige för UNHCR](https://sverigeforunhcr.se), a swedish partner of the [UNHCR - The UN Refugee Agency](http://www.unhcr.org), a global organisation dedicated to saving lives, protecting rights and building a better future for refugees, forcibly displaced communities and stateless people.

### License

Read the [license](./LICENSE.md) for permissions and limitations.