ziti-sdk-js

A JavaScript-based SDK for delivering secure browser-based web applications over a Ziti Network

Learn about Ziti at ziti.dev

• Motivation
• Features
• Installation via NPM
• Installation via jsDelivr CDN
• Installation via unpkg CDN
• Configuration
• License

Motivation

tbd

Features

tbd

Installing via NPM

If you want to embed ziti-sdk-js in your build, it is available through npm. Simply run the following command:

npm i @openziti/ziti-sdk-js

You can then use ziti-sdk-js as a regular module:

const ziti = require('@openziti/ziti-sdk-js');

Installing via jsDelivr CDN

If you want to use ziti-sdk-js directly from the jsDelivr CDN, simply include this in your html:

For latest version:

<script src="https://cdn.jsdelivr.net/npm/@openziti/ziti-sdk-js@latest/dist/ziti.min.js"></script>

For specific version (e.g. 0.4.8):

<script src="https://cdn.jsdelivr.net/npm/@openziti/ziti-sdk-js@0.4.8/dist/ziti.min.js"></script>

The above bundles will synchronously create a global ziti object that you can call.

Installing via unpkg CDN

If you want to use ziti-sdk-js directly from the unpkg CDN, simply include this in your html:

For latest version:

<script src="https://unpkg.com/@openziti/ziti-sdk-js@latest/dist/ziti.min.js"></script>

For specific version (e.g. 0.4.8):

<script src="https://unpkg.com/@openziti/ziti-sdk-js@0.4.8/dist/ziti.min.js"></script>

The above bundles will synchronously create a global ziti object that you can call.

Configuration

tbd

License

Apache 2.0