update docs

README.md

@@ -2,21 +2,25 @@
 
 This collection of Rancher extensions is designed to provide additional functionality to the Rancher dashboard, particularly to fill user-experience gaps for non-operator users.
 
-## App Launcher
+## Platform Tools
 
-Currently, if a user wants to access a software application running in Rancher/kubernetes, they need to dig deep into the services/ingress section in Rancher, or learn how to build the proxy URL or on their own. Otherwise, operators need to use an ingress to create convenient access for users.
+### [App Launcher](./pkg/app-launcher/README.md)
+
+Currently, if a user wants to access a software application running in Rancher/kubernetes, they need to dig deep into the services/ingress section in Rancher, or learn how to build the proxy URL on their own. Otherwise, operators need to use an ingress to create convenient access for users.
 
 However, the proxy URL can be a powerful tool in Rancher. It allows a user with appropriate access to a namespaced resource to access that resource/application without ingress.
 
 The App Launcher will expose a top-level directory of service/ingress objects, and will assemble proxy URLs. It will also provide an option to launch that ingress, if available.
 
-## Pirate Language (unreleased)
+## i18n
+
+### [Pirate Locale (unreleased)](./pkg/pirate-locale/README.md)
 
 This extension, for fun, is intended to demonstrate internationalization (i18n) for Rancher via Rancher extensions, as an homage to the Google search pirate translation from years ago.
 
 This is currently unreleased, but will be available in the future. Contributions are welcome.
 
-# Install for Rancher
+# Installation
 
 To install the extension, you will need Rancher 2.7.6 or later.
 
@@ -52,9 +56,12 @@ To install the extension, you will need Rancher 2.7.6 or later.
 
 Profit!
 
-# Setup for Development
+# Development
+
+## Requirements
+
+The extensions and the Rancher Dashboard code are currently built with Node 16.
 
-### Node
 We recommend managing node versions with [nvm](https://github.com/nvm-sh/nvm).
 
 ```sh
@@ -63,13 +70,28 @@ cd # project directory
 nvm install $(cat package.json | grep '\"node\": ' | grep -o '[0-9.]*')
 ```
 
+When using nvm, you can use the following command to switch to the correct node version:
+
+```sh
+  nvm use 16
+```
+
+<!-- verify if we actually need this.
 ### Yarn
 
 We use [corepack](https://nodejs.org/api/corepack.html) (comes with Node.js) to manager our package manger's version. To install, run the following from the project's root directory.
 
 ```
 corepack enable
-```
+``` -->
+
+## Starting development
+
+1. Clone this repository
+
+2. Run `yarn install`
+
+3. Run `API=<Rancher Backend base URL> yarn dev`
 
 ## Troubleshooting
 

pkg/app-launcher/README.md

@@ -1,6 +1,18 @@
 # Rancher App Launcher Extension
 
-Rancher App Launcher Extension is a powerful tool for improved accessibility and resource discovery within the Rancher ecosystem. The extension is designed to extract ingresses from various clusters and consolidate them into a unified global resource page. With neatly organized cards for each discovered service, the tool offers an efficient method of displaying and accessing your Rancher services, making the Rancher experience seamless for both new and experienced users.
+Rancher App Launcher Extension is a simple yet powerful tool for improved accessibility and resource discovery within Kubernetes. The extension is designed to extract ingresses from various clusters and consolidate them into a unified global resource page. With neatly organized cards for each discovered service, the tool offers an efficient method of displaying and accessing your Rancher services, making the Rancher experience seamless for both new and experienced users.
+
+The extension intends to improve the discoverability of services and offer a straightforward way to navigate the complexities of multi-cluster environments.
+
+<img src="./docs/images/preview.png" width="50%" alt="App Launcher Extension preview image">
+
+## Features
+
+- Unified resource page for all discovered services and ingresses
+- Convenient access to services with a simple click
+- Global apps section for user-selected favorites and global apps defined by cluster YAML files
+- Grid and list views for easy navigation
+- Multi-cluster support for viewing services across different clusters
 
 ## How to Run
 
@@ -10,12 +22,29 @@ Rancher App Launcher Extension is a powerful tool for improved accessibility and
 
 ## Usage
 
-- Once the Rancher App Launcher Extension is installed, you can access a unified resource page from the main dashboard.
+### Tag "Global" Apps
+
+Global apps will show at the top of the App Launcher page as a combination of global apps defined by cluster YAML files and user-selected favorites.
+
+- Apps tagged in Yaml will persist for all users.
+- (currently) User-selected favorites will only persist for the user who selected them and are stored in the browser's local storage.
+
+To select a Service or Ingress as a Global App, add the following annotation to the Service or Ingress:
+
+```yaml
+metadata:
+  annotations:
+    extensions.applauncher/global-app: "true"
+```
+
+### Filter by Name
+
+
+
+### Filter by Cluster
+
 - This page showcases cards for each discovered service and ingress, allowing you to conveniently open the service with a simple click.
-    *The extension is designed to improve discoverability, and offer a straightforward way to navigate the complexities of multi-cluster environments.*
-- Global apps will show at the top as a combination of global apps defined by cluster YAML files and user-selected favorites
-    *\*note: global apps can be set by modifying the service's `metadata.annotations['extensions.applauncher/global-app']` to 'true'*
-- Select different clusters to view the services of. Global Apps perisist across all views.
+    *The extension is designed to improve discoverability and offer a straightforward way to navigate the complexities of multi-cluster environments.*
 - The view can be changed with the view buttons from grid to list views.
 
 ## Contribution