sogouda v0.2.3

sogouda

This package exposes Sogouda as a JavaScript/TypeScript library.

For more information, please refer to the main repository.

Installation

As a library

To install the sogouda as a dependency of your package, please run the following command:

npm i sogouda

As an executable

To install the sogouda executable globally for the user, please run the following command:

npm i -g sogouda

For use within package scripts

To use sogouda from within package scripts, please run the following command:

npm i -D sogouda

Usage (executable)

Load an app image

Locally

sogouda --title "Example App" --url file:///path/to/the/app/index.html

Remotely

sogouda --title "Example App" --url https://example.com

Usage (library)

Load an app image

Locally

import { App } from "sogouda";


// Set the app's options.
const options = {
    title: "Example App",
    url: "file:///path/to/the/app/index.html"
};

// Create the app context.
const app = new App(options);

// Start the app.
app.startSync();

Remotely

import { App } from "sogouda";


// Set the app's options.
const options = {
    title: "Example App",
    url: "https://example.com"
};

// Create the app context.
const app = new App(options);

// Start the app.
app.startSync();