chore: add README

Author: ayushmanchhabra

README.md

@@ -1,6 +1,6 @@
-# @nwutils/getter
+# @nwutils/runner
 
-[![npm](https://img.shields.io/npm/v/@nwutils/getter/latest)](https://www.npmjs.com/package/@nwutils/getter/v/latest)
+[![npm](https://img.shields.io/npm/v/@nwutils/runner/latest)](https://www.npmjs.com/package/@nwutils/runner/v/latest)
 
 Download NW.js and related binaries for Linux, MacOS and Windows.
 
@@ -12,40 +12,29 @@ Download NW.js and related binaries for Linux, MacOS and Windows.
 ## Usage
 
 ```js
-import get from "@nwutils/getter";
+import run from "@nwutils/runner";
 
 await get({
     version: "latest",
     flavor: "normal",
     platform: "linux",
     arch: "x64",
-    downloadUrl: "https://dl.nwjs.io",
-    manifestUrl: "https://nwjs.io/versions.json",
     cacheDir: "./cache",
-    cache: true,
-    ffmpeg: false,
-    nativeAddon: false,
-    shaSum: true,
 });
 ```
 
 ## API Reference
 
 Options
 
-| Name | Type    | Description |
-| ---- | ------- | ----------- |
-| version | `string \| "latest" \| "stable"` | Runtime version |
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| version | `string` | Runtime version |
 | flavor | `"normal" \| "sdk"` | Runtime flavor |
 | platform | `"linux" \| "osx" \| "win"` | Host platform |
 | arch | `"ia32" \| "x64" \| "arm64"` | Host architecture |
-| downloadUrl | `"https://dl.nwjs.io" \| "https://npm.taobao.org/mirrors/nwjs" \| https://npmmirror.com/mirrors/nwjs \| "https://github.com/corwin-of-amber/nw.js/releases/"` | Download server. Supports file systems too (for example `file:///home/user/nwjs_mirror`) |
-| manifestUrl | `"https://nwjs.io/versions.json" \| "https://raw.githubusercontent.com/nwutils/nw-builder/main/src/util/osx.arm.versions.json"` | Versions manifest |
 | cacheDir | `string` | Directory to cache NW binaries |
-| cache | `boolean` | If true the existing cache is used. Otherwise it removes and redownloads it. |
-| ffmpeg | `boolean` | If true the chromium ffmpeg is replaced by community version with proprietary codecs. |
-| nativeAddon | `boolean` | If true download NW.js Node headers. |
-| shaSum | `boolean` | Flag to enable/disable shasum checks. |
+| argv | `string[]` | List of CLI arguments to be passed to NW.js. |
 
 ## Contributing