-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
1 changed file
with
10 additions
and
95 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,102 +1,17 @@ | ||
| `ziti-sdk-js` | ||
| ===================== | ||
| # 🚨 Ziti SDK for JavaScript - Archived and No Longer Maintained 🚨 | ||
|
|
||
| A JavaScript-based SDK for delivering secure browser-based web applications over a [Ziti Network](https://ziti.dev/about) | ||
| ## ⚠️ Repository Status: **Defunct** | ||
| This repository is no longer maintained or supported as of 2021-11-11. No further updates, bug fixes, or support will be provided for the Ziti SDK for JavaScript. | ||
|
|
||
| <img src="https://ziti.dev/wp-content/uploads/2020/02/ziti.dev_.logo_.png" width="200" /> | ||
| --- | ||
|
|
||
| Learn about Ziti at [ziti.dev](https://ziti.dev) | ||
| ## Why Was This Archived? | ||
| The Ziti SDK for JavaScript has been discontinued and will be replaced by a future `ziti-sdk-browser`. | ||
|
|
||
| --- | ||
|
|
||
| []() | ||
| []() | ||
| [](https://snyk.io/test/npm/@openziti/ziti-sdk-js) | ||
| [](https://opensource.org/licenses/Apache-2.0) | ||
| [![npm version][npm-image]][npm-url] | ||
| [](https://www.jsdelivr.com/package/npm/@openziti/ziti-sdk-js) | ||
| []() | ||
| [](CONTRIBUTING.md) | ||
| [](CODE_OF_CONDUCT.md) | ||
| [](https://app.codesee.io/maps/public/12213800-239c-11ec-8afb-0d2533b87e31) | ||
| ## Recommendations | ||
| If you are seeking alternatives or similar functionality, consider: | ||
|
|
||
| - **[OpenZiti SDKs](https://github.com/openziti):** Explore other actively maintained SDKs within the OpenZiti ecosystem. | ||
|
|
||
| <!-- TOC --> | ||
|
|
||
| - [Motivation](#motivation) | ||
| - [Features](#features) | ||
| - [Installation via NPM](#installing-via-NPM) | ||
| - [Installation via jsDelivr CDN](#Installing-via-jsDelivr-CDN) | ||
| - [Installation via unpkg CDN](#Installing-via-unpkg-CDN) | ||
| - [Configuration](#configuration) | ||
| - [License](#license) | ||
|
|
||
| <!-- /TOC --> | ||
|
|
||
|
|
||
| ## Motivation | ||
|
|
||
| tbd | ||
|
|
||
| ## Features | ||
|
|
||
| tbd | ||
|
|
||
|
|
||
| ## Installing via NPM | ||
|
|
||
| If you want to embed `ziti-sdk-js` in your build, it is available through [npm](https://www.npmjs.com/package/@openziti/ziti-sdk-js). Simply run the following command: | ||
|
|
||
| npm i @openziti/ziti-sdk-js | ||
|
|
||
| You can then use `ziti-sdk-js` as a regular module: | ||
|
|
||
| ```js | ||
| const ziti = require('@openziti/ziti-sdk-js'); | ||
| ``` | ||
|
|
||
| ### Installing via jsDelivr CDN | ||
|
|
||
| If you want to use `ziti-sdk-js` directly from the [jsDelivr CDN](https://www.jsdelivr.com/package/npm/@openziti/ziti-sdk-js), simply include this in your html: | ||
|
|
||
| For `latest` version: | ||
| ```html | ||
| <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`): | ||
| ```html | ||
| <script src="https://cdn.jsdelivr.net/npm/@openziti/[email protected]/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](https://unpkg.com/#/), simply include this in your html: | ||
|
|
||
| For `latest` version: | ||
| ```html | ||
| <script src="https://unpkg.com/@openziti/ziti-sdk-js@latest/dist/ziti.min.js"></script> | ||
| ``` | ||
|
|
||
| For specific version (e.g. `0.4.8`): | ||
| ```html | ||
| <script src="https://unpkg.com/@openziti/[email protected]/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 | ||
|
|
||
|
|
||
|
|
||
| [npm-image]: https://flat.badgen.net/npm/v/@openziti/ziti-sdk-js | ||
| [npm-url]: https://www.npmjs.com/package/@openziti/ziti-sdk-js | ||
| [install-size-image]: https://flat.badgen.net/packagephobia/install/@openziti/ziti-sdk-js | ||
| [install-size-url]: https://packagephobia.now.sh/result?p=@openziti/ziti-sdk-js |