add more to readme

nodegui · Oct 25, 2019 · dd6730e · dd6730e
1 parent 2c6466f
commit dd6730e
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,32 @@
 # nodegui-os-utils
+
 A nodegui helper module which will contain OS specific native features which Qt doesnt support and hence requires native code in respective operting systems.
+
+# Installation
+
+```
+npm install @nodegui/nodegui-os-utils
+```
+
+# Usage
+
+```js
+import { Dock } from "@nodegui/nodegui-os-utils";
+
+console.log("Showing the Dock Icon on MacOS");
+Dock.show();
+console.log("Hiding the Dock Icon on MacOS");
+Dock.hide();
+```
+
+# Supported APIs
+
+## MacOS
+
+- Dock
+  - `show()` - static method - Shows the dock icon of the nodegui app on macos. Noop on other platforms.
+  - `hide()` - static method - Hides the dock icon of the nodegui app on macos. Noop on other platforms.
+
+# License
+
+MIT
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "nodegui-os-utils",
+  "name": "@nodegui/nodegui-os-utils",
   "version": "1.0.0",
   "description": "A NodeGui native plugin for managing macOS native apis",
   "main": "dist/index.js",