first commit

node_modules/os-name/readme.md

@@ -0,0 +1,50 @@
+# os-name
+
+> Get the name of the current operating system\
+> Example: `macOS Sierra`
+
+Useful for analytics and debugging.
+
+## Install
+
+```sh
+npm install os-name
+```
+
+## Usage
+
+```js
+import os from 'node:os';
+import osName from 'os-name';
+
+// On a macOS Sierra system
+
+osName();
+//=> 'macOS Sierra'
+
+osName(os.platform(), os.release());
+//=> 'macOS Sierra'
+
+osName('darwin', '14.0.0');
+//=> 'OS X Yosemite'
+
+osName('linux', '3.13.0-24-generic');
+//=> 'Linux 3.13'
+
+osName('win32', '6.3.9600');
+//=> 'Windows 8.1'
+```
+
+## API
+
+### osName(platform?, release?)
+
+By default, the name of the current operating system is returned.
+
+You can optionally supply a custom [`os.platform()`](https://nodejs.org/api/os.html#os_os_platform) and [`os.release()`](https://nodejs.org/api/os.html#os_os_release).
+
+Check out [`getos`](https://github.com/wblankenship/getos) if you need the Linux distribution name.
+
+## Related
+
+- [os-name-cli](https://github.com/sindresorhus/os-name-cli) - CLI for this module