Update README.md

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.
+<p align="center" width="100%">
+OpenZiti is a free and open source project focused on bringing zero trust to any application.
+     <br>
+The project provides all the pieces required to implement or integrate zero trust into your solutions.
+<br/>
+<br/>
+     <br>
+</p>
 
-## Code scaffolding
+<p align="center" width="100%">
+<a href="https://openziti.io"><img src="https://github.com/rgallettonf/ziti-console-npm/blob/main/projects/ziti-console-lib/src/lib/assets/icons/android-icon-192x192.png?raw=true" width="100"></a>
+</p>
 
-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. 
+<p align="center">
+    <b>
+    <a>@openziti/ziti-console</a>
+    <br>
+    <br>
+    </b>
+    This repo hosts the Ziti Admin Console, and is designed to provide a user interface to help you administrate an <a href="https://openziti.io">OpenZiti Network</a> via the <a href="https://openziti.io/docs/reference/developer/api/">Ziti Edge API</a>
+    <br>
+    <br>
+    <b>Part of the <a href="https://openziti.io/about">OpenZiti</a> ecosystem</b>
+</p>
+
+<p align="center">
+    <br>
+    <b>Interested in knowing how to easily embed programmable, high performance, zero trust networking into your application without VPNs?</b>
+    <br>
+    Learn more about <a href="https://openziti.io/about">OpenZiti</a> project.</b>
+    <br>
+    Also, checkout core project on <a href="https://github.com/openziti">github</a>
+<br/>
+<br/>
+Please star us!
+<br/>
+<a href="https://github.com/openziti/ziti/stargazers"><img src="https://img.shields.io/github/stars/openziti/ziti?style=flat" ></a>
+    </p>
+
+---
+[![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 <a href="https://openziti.io">OpenZiti Network</a>
 
-## Build
+This library is imported and extended via the <a href="https://openziti.io">Ziti Admin Console</a>, 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 <a href="https://github.com/openziti/ziti-console">ziti-console</a> 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