Skip to content

Commit dd6730e

Browse files
committed
add more to readme
1 parent 2c6466f commit dd6730e

File tree

3 files changed

+32
-2
lines changed

3 files changed

+32
-2
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,32 @@
11
# nodegui-os-utils
2+
23
A nodegui helper module which will contain OS specific native features which Qt doesnt support and hence requires native code in respective operting systems.
4+
5+
# Installation
6+
7+
```
8+
npm install @nodegui/nodegui-os-utils
9+
```
10+
11+
# Usage
12+
13+
```js
14+
import { Dock } from "@nodegui/nodegui-os-utils";
15+
16+
console.log("Showing the Dock Icon on MacOS");
17+
Dock.show();
18+
console.log("Hiding the Dock Icon on MacOS");
19+
Dock.hide();
20+
```
21+
22+
# Supported APIs
23+
24+
## MacOS
25+
26+
- Dock
27+
- `show()` - static method - Shows the dock icon of the nodegui app on macos. Noop on other platforms.
28+
- `hide()` - static method - Hides the dock icon of the nodegui app on macos. Noop on other platforms.
29+
30+
# License
31+
32+
MIT

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "nodegui-os-utils",
2+
"name": "@nodegui/nodegui-os-utils",
33
"version": "1.0.0",
44
"description": "A NodeGui native plugin for managing macOS native apis",
55
"main": "dist/index.js",

0 commit comments

Comments
 (0)