Skip to content

Commit

Permalink
docs: adds Examples reference in main README and adds README to examp…
Browse files Browse the repository at this point in the history 
…les directory
  • Loading branch information
@jbottigliero
jbottigliero committed May 14, 2024
1 parent 899df82 commit 267c146
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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).

Expand Down
15 changes: 15 additions & 0 deletions examples/README.md
View file
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 267c146

Please sign in to comment.