Skip to content

Commit dfa9669

Browse files
committed
docs: add keywords and versioning
1 parent f4e75b6 commit dfa9669

File tree

2 files changed

+24
-6
lines changed

2 files changed

+24
-6
lines changed

Diff for: packages/native-machine-id/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ import { getMachineID } from 'native-machine-id';
2424

2525
// Get the machine ID
2626
const hashedId = getMachineID();
27-
console.log('SHA-256 Hashed Machine ID:', id);
28-
const id = getMachineID({ raw: true });
29-
console.log('Original Machine ID:', id);
27+
console.log('SHA-256 Hashed Machine ID:', hashedId);
28+
const rawId = getMachineID({ raw: true });
29+
console.log('Original Machine ID:', rawId);
3030
```
3131

3232
## Supported Platforms
@@ -37,7 +37,7 @@ console.log('Original Machine ID:', id);
3737

3838
## Comparison with `node-machine-id`
3939

40-
This module provides similar functionality to [node-machine-id](https://www.npmjs.com/package/node-machine-id), but **using native access to system APIs without the need for child processes**, making it much faster and reliable.
40+
This module provides similar functionality to [node-machine-id](https://www.npmjs.com/package/node-machine-id) while **using native access to system APIs without the need for child processes**, making it much faster and reliable.
4141

4242
Here's a table of performance comparisons between the two libraries, based on the average runtime from 1000 iterations of the `getMachineId` and `machineIdSync` functions, from `scripts/benchmark.ts`:
4343

Diff for: packages/native-machine-id/package.json

+20-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "native-machine-id",
3-
"version": "1.1.0",
3+
"version": "0.0.2",
44
"description": "Native retrieval of a unique desktop machine ID without admin privileges or child processes. Faster and more reliable alternative to node-machine-id.",
55
"main": "dist/index.js",
66
"types": "dist/index.d.ts",
@@ -58,5 +58,23 @@
5858
"node-machine-id": "^1.1.12",
5959
"typescript": "^5.0.4",
6060
"ts-node": "^10.9.2"
61-
}
61+
},
62+
"keywords": [
63+
"machine id",
64+
"node machine id",
65+
"device identifier",
66+
"node id",
67+
"unique identifier",
68+
"device id",
69+
"machine identifier",
70+
"unique id",
71+
"platform id",
72+
"electron id",
73+
"node-machine-id",
74+
"uuid",
75+
"restrictions",
76+
"native",
77+
"telemetry",
78+
"telemetry id"
79+
]
6280
}

0 commit comments

Comments
 (0)