aboutsummaryrefslogtreecommitdiff
path: root/node_modules/os-locale/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/os-locale/readme.md')
-rw-r--r--node_modules/os-locale/readme.md53
1 files changed, 53 insertions, 0 deletions
diff --git a/node_modules/os-locale/readme.md b/node_modules/os-locale/readme.md
new file mode 100644
index 0000000..7c80d33
--- /dev/null
+++ b/node_modules/os-locale/readme.md
@@ -0,0 +1,53 @@
+# os-locale [![Build Status](https://travis-ci.org/sindresorhus/os-locale.svg?branch=master)](https://travis-ci.org/sindresorhus/os-locale)
+
+> Get the system [locale](https://en.wikipedia.org/wiki/Locale_(computer_software))
+
+Useful for localizing your module or app.
+
+POSIX systems: The returned locale refers to the [`LC_MESSAGE`](http://www.gnu.org/software/libc/manual/html_node/Locale-Categories.html#Locale-Categories) category, suitable for selecting the language used in the user interface for message translation.
+
+
+## Install
+
+```
+$ npm install --save os-locale
+```
+
+
+## Usage
+
+```js
+const osLocale = require('os-locale');
+
+osLocale().then(locale => {
+ console.log(locale);
+ //=> 'en_US'
+});
+```
+
+
+## API
+
+### osLocale([options])
+
+Returns a `Promise` for the locale.
+
+### osLocale.sync([options])
+
+Returns the locale.
+
+#### options
+
+Type: `Object`
+
+##### spawn
+
+Type: `boolean`<br>
+Default: `true`
+
+Set to `false` to avoid spawning subprocesses and instead only resolve the locale from environment variables.
+
+
+## License
+
+MIT © [Sindre Sorhus](https://sindresorhus.com)