Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jooy2 committed Aug 5, 2024
1 parent 1c14e0b commit a51380f
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,17 @@
`machini` is a utility to get hardware information about system devices.

- Lightweight and Fast!
- It doesn't use any additional modules - it utilizes pure NodeJS APIs.
- It doesn't use any additional modules - it utilizes pure Node.js APIs.
- You don't need system privileges to get the value.
- Friendly to modern **Node.js** development and [**TypeScript**](https://www.typescriptlang.org).
- Cross-platform (Windows, macOS, Unix/Linux) support.

## Installation

> [!NOTE]
>
> `machini` is a module that runs on the Node.js runtime and is not available in a typical web environment (client). Since it utilizes the runtime of Node.js to get device information, it defeats the purpose of getting the end user's device information. To get the client's device ID, consider a solution like UUID (`randomUUID` in `crypto`).
`machini` requires `Node.js 18.x` or higher, and the repository is serviced through **[NPM](https://npmjs.com)**.

`machini` is **ESM-only**. You must use `import` instead of `require` to load the module. There are workarounds available for CommonJS, but we recommend using ESM based on recent JavaScript trends.
Expand Down

0 comments on commit a51380f

Please sign in to comment.