diff --git a/README.md b/README.md index 2af5a9f..256e189 100644 --- a/README.md +++ b/README.md @@ -14,131 +14,4 @@ The Ziti SDK for JavaScript has been discontinued and will be replaced by a futu If you are seeking alternatives or similar functionality, consider: - **[OpenZiti SDKs](https://github.com/openziti):** Explore other actively maintained SDKs within the OpenZiti ecosystem. -- **[Alternative Project 1](https://example.com):** Short description of the alternative (if applicable). -If you still find value in this repository, feel free to fork it and adapt it to your use case. - ---- - -## Last Stable Release -The last stable release is tagged as [vX.X.X](https://github.com/openziti/ziti-sdk-js/releases/tag/vX.X.X). You can access it in the [Releases section](https://github.com/openziti/ziti-sdk-js/releases). - ---- - -## License -This project remains licensed under the [Apache License 2.0](LICENSE). See the [LICENSE](LICENSE) file for more details. - ---- - -Thank you to everyone who contributed to this project. Your support and collaboration have been greatly appreciated. 🎉 - ---- - -### Example Screenshot of Archive Status - -*Include a screenshot here showing the "This repository has been archived" banner from GitHub.* - - - -`ziti-sdk-js` -===================== - -A JavaScript-based SDK for delivering secure browser-based web applications over a [Ziti Network](https://ziti.dev/about) - - - -Learn about Ziti at [ziti.dev](https://ziti.dev) - - -[![Build](https://github.com/openziti/ziti-sdk-js/workflows/Build/badge.svg?branch=main)]() -[![Issues](https://img.shields.io/github/issues-raw/openziti/ziti-sdk-js)]() -[![Known Vulnerabilities](https://snyk.io/test/npm/@openziti/ziti-sdk-js/badge.svg)](https://snyk.io/test/npm/@openziti/ziti-sdk-js) -[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) -[![npm version][npm-image]][npm-url] -[![](https://data.jsdelivr.com/v1/package/npm/@openziti/ziti-sdk-js/badge?style=rounded)](https://www.jsdelivr.com/package/npm/@openziti/ziti-sdk-js) -[![LOC](https://img.shields.io/tokei/lines/github/openziti/ziti-sdk-js)]() -[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=rounded)](CONTRIBUTING.md) -[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md) -[![CodeSee](https://codesee-docs.s3.amazonaws.com/badge.svg)](https://app.codesee.io/maps/public/12213800-239c-11ec-8afb-0d2533b87e31) - - - - -- [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) - - - - -## 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 - -``` -For specific version (e.g. `0.4.8`): -```html - -``` - -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 - -``` - -For specific version (e.g. `0.4.8`): -```html - -``` -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