From 2775d4a4c0b8813abb3f537b388627fc0eaf81ba Mon Sep 17 00:00:00 2001 From: rgallettonf <102923745+rgallettonf@users.noreply.github.com> Date: Tue, 9 Jul 2024 17:06:49 -0400 Subject: [PATCH] Update README.md --- projects/ziti-console-lib/README.md | 79 +++++++++++++++++++++++++---- 1 file changed, 68 insertions(+), 11 deletions(-) diff --git a/projects/ziti-console-lib/README.md b/projects/ziti-console-lib/README.md index 75191a21..ac866d80 100644 --- a/projects/ziti-console-lib/README.md +++ b/projects/ziti-console-lib/README.md @@ -1,23 +1,80 @@ -# Ziti Admin Console +![Ziggy using the ziti-console](https://raw.githubusercontent.com/rgallettonf/ziti-console-npm/main/projects/ziti-console-lib/src/lib/assets/banners/ZAC.jpg) -This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 16.0.0. +

+OpenZiti is a free and open source project focused on bringing zero trust to any application. +
+The project provides all the pieces required to implement or integrate zero trust into your solutions. +
+
+
+

-## Code scaffolding +

+ +

-Run `ng generate component component-name --project ziti-console-lib` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project ziti-console-lib`. -> Note: Don't forget to add `--project ziti-console-lib` or else it will be added to the default project in your `angular.json` file. +

+ + @openziti/ziti-console +
+
+ + This repo hosts the Ziti Admin Console, and is designed to provide a user interface to help you administrate an OpenZiti Network via the Ziti Edge API +
+
+ Part of the OpenZiti ecosystem +

+ +

+
+ Interested in knowing how to easily embed programmable, high performance, zero trust networking into your application without VPNs? +
+ Learn more about OpenZiti project. +
+ Also, checkout core project on github +
+
+Please star us! +
+ +

+ +--- +[![Issues](https://img.shields.io/github/issues-raw/openziti/ziti-console)]() +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) +[![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) + +--- + + +# ziti-console-lib + +ziti-console-lib is a shared Angular library that exports components used to administrate an OpenZiti Network -## Build +This library is imported and extended via the Ziti Admin Console, but can also be used in other 3rd party Angular applications. -Run `ng build ziti-console-lib` to build the project. The build artifacts will be stored in the `dist/` directory. -## Publishing +## How to install -After building your library with `ng build ziti-console-lib`, go to the dist folder `cd dist/ziti-console-lib` and run `npm publish`. +To install this library in an angular application, run the following command from your project root: -## Running unit tests +``` +npm install @openziti/ziti-console-lib +``` -Run `ng test ziti-console-lib` to execute the unit tests via [Karma](https://karma-runner.github.io). +This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 16.0.0. + +## Building From Source +After checking out the main ziti-console github project, + +Run `ng build ziti-console-lib` from the project root to build the shared library. The build artifact will be stored in the `dist/` directory. + + +## Code scaffolding + +Run `ng generate component component-name --project ziti-console-lib` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project ziti-console-lib`. +> Note: Don't forget to add `--project ziti-console-lib` or else it will be added to the default project in your `angular.json` file. ## Further help