From 267c146b191588afa6fff71d10eb50dda03b9423 Mon Sep 17 00:00:00 2001
From: Joe Bottigliero <694253+jbottigliero@users.noreply.github.com>
Date: Tue, 14 May 2024 12:13:59 -0500
Subject: [PATCH] docs: adds Examples reference in main README and adds README
 to examples directory

---
 README.md          | 12 ++++++------
 examples/README.md | 15 +++++++++++++++
 2 files changed, 21 insertions(+), 6 deletions(-)
 create mode 100644 examples/README.md

diff --git a/README.md b/README.md
index 47870298..0ff82fbb 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,9 @@
 [![npm](https://img.shields.io/npm/v/@globus/sdk?style=flat-square&logo=npm&color=000&label)](https://www.npmjs.com/package/@globus/sdk) [![Codecov](https://img.shields.io/codecov/c/gh/globus/globus-sdk-javascript?style=flat-square&logo=codecov)](https://app.codecov.io/gh/globus/globus-sdk-javascript)
 
-
 The Globus SDK for JavaScript provides first class TypeScript support and makes it easy to call Globus services using idiomatic JavaScript APIs to build Node.js and web applications.
 
 - [@globus/sdk API Documentation](https://globus.github.io/globus-sdk-javascript/)
+- [Examples](./examples/README.md)
 
 ## Installation
 
@@ -27,11 +27,11 @@ npm install @globus/sdk @globus/types
 
 We aim to support all Active LTS [Node.js releases](https://nodejs.org/en/about/previous-releases). We intend to support all Maintenance LTS versions until their official end-of-life.
 
-| Version    |                                                                                                                                                                                                                     |                                                                                                                                                                                       |
-| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Node.js 18 | [![lts/hydrogen](https://img.shields.io/github/actions/workflow/status/globus/globus-sdk-javascript/ci.yml?style=flat-square&label=)](https://github.com/globus/globus-sdk-javascript/actions/workflows/ci.yml) |                                                                                                                                                                                       |
-| Node.js 20 | [![lts/iron](https://img.shields.io/github/actions/workflow/status/globus/globus-sdk-javascript/ci.yml?style=flat-square&label=)](https://github.com/globus/globus-sdk-javascript/actions/workflows/ci.yml)     |                                                                                                                                                                                       |
-| Node.js 22 | 🧪 Experimental Support[^1]                                                                                                                                                                                         |                                                                                                                                                                                       |
+| Version    |                                                                                                                                                                                                                 |     |
+| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- |
+| Node.js 18 | [![lts/hydrogen](https://img.shields.io/github/actions/workflow/status/globus/globus-sdk-javascript/ci.yml?style=flat-square&label=)](https://github.com/globus/globus-sdk-javascript/actions/workflows/ci.yml) |     |
+| Node.js 20 | [![lts/iron](https://img.shields.io/github/actions/workflow/status/globus/globus-sdk-javascript/ci.yml?style=flat-square&label=)](https://github.com/globus/globus-sdk-javascript/actions/workflows/ci.yml)     |     |
+| Node.js 22 | 🧪 Experimental Support[^1]                                                                                                                                                                                     |     |
 
 [^1]: Not covered by automated test suite(s).
 
diff --git a/examples/README.md b/examples/README.md
new file mode 100644
index 00000000..d3eb0f02
--- /dev/null
+++ b/examples/README.md
@@ -0,0 +1,15 @@
+# Examples
+
+## Browser
+
+- [Basic](./basic)
+  - Demonstrates basic usage of the SDK in a browser environment.
+
+## Applications
+
+- [`globus/static-data-portal`](https://github.com/globus/static-data-portal) (Next.js, React, Typescript)
+
+  - Uses the SDK to authenticate users and interact with Globus Transfer.
+
+- [`globus/static-search-portal`](https://github.com/globus/static-search-portal) (Next.js, React, Typescript)
+  - Uses the SDK to authenticate users and interact with Globus Search.