docs: regenerate documentation

globus · Oct 28, 2024 · b9aa6f5 · b9aa6f5
1 parent dd4f18f
commit b9aa6f5
Show file tree

Hide file tree

Showing 8 changed files with 13 additions and 7 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -8,6 +8,12 @@
 
 A simple React context for managing Globus-related authentication state, built on top of the [@globus/sdk](https://github.com/globus/globus-sdk-javascript).
 
+## Installation
+
+```
+npm install --save @globus/sdk @globus/react-auth-context
+```
+
 ## Usage
 
 The package includes a `<Provider>` that can be configured with a `client`, `scopes`, and `redirect` that will be used to configure an `AuthorizationManager` instance for the context. The `useGlobusAuth` hook can be used to access the authentication state and the `AuthorizationManager` instance.

diff --git a/docs/functions/Provider.md b/docs/functions/Provider.md
@@ -18,4 +18,4 @@
 
 ## Defined in
 
-[Provider.tsx:21](https://github.com/globus/react-auth-context/blob/f12539af272bb8ebd6d198a34aa9ee5c5ed146c2/src/Provider.tsx#L21)
+[Provider.tsx:21](https://github.com/globus/react-auth-context/blob/dd4f18f00c59a4d730366bf281f83506ce9ff987/src/Provider.tsx#L21)
diff --git a/docs/functions/reducer.md b/docs/functions/reducer.md
@@ -20,4 +20,4 @@
 
 ## Defined in
 
-[reducer.ts:5](https://github.com/globus/react-auth-context/blob/f12539af272bb8ebd6d198a34aa9ee5c5ed146c2/src/reducer.ts#L5)
+[reducer.ts:5](https://github.com/globus/react-auth-context/blob/dd4f18f00c59a4d730366bf281f83506ce9ff987/src/reducer.ts#L5)
diff --git a/docs/functions/useGlobusAuth.md b/docs/functions/useGlobusAuth.md
@@ -14,4 +14,4 @@
 
 ## Defined in
 
-[useGlobusAuth.ts:4](https://github.com/globus/react-auth-context/blob/f12539af272bb8ebd6d198a34aa9ee5c5ed146c2/src/useGlobusAuth.ts#L4)
+[useGlobusAuth.ts:4](https://github.com/globus/react-auth-context/blob/dd4f18f00c59a4d730366bf281f83506ce9ff987/src/useGlobusAuth.ts#L4)
diff --git a/docs/type-aliases/GlobusAuthContextProps.md b/docs/type-aliases/GlobusAuthContextProps.md
@@ -10,4 +10,4 @@
 
 ## Defined in
 
-[Context.ts:4](https://github.com/globus/react-auth-context/blob/f12539af272bb8ebd6d198a34aa9ee5c5ed146c2/src/Context.ts#L4)
+[Context.ts:4](https://github.com/globus/react-auth-context/blob/dd4f18f00c59a4d730366bf281f83506ce9ff987/src/Context.ts#L4)
diff --git a/docs/type-aliases/GlobusAuthState.md b/docs/type-aliases/GlobusAuthState.md
@@ -28,4 +28,4 @@
 
 ## Defined in
 
-[State.ts:3](https://github.com/globus/react-auth-context/blob/f12539af272bb8ebd6d198a34aa9ee5c5ed146c2/src/State.ts#L3)
+[State.ts:3](https://github.com/globus/react-auth-context/blob/dd4f18f00c59a4d730366bf281f83506ce9ff987/src/State.ts#L3)
diff --git a/docs/type-aliases/Props.md b/docs/type-aliases/Props.md
@@ -10,4 +10,4 @@
 
 ## Defined in
 
-[Provider.tsx:14](https://github.com/globus/react-auth-context/blob/f12539af272bb8ebd6d198a34aa9ee5c5ed146c2/src/Provider.tsx#L14)
+[Provider.tsx:14](https://github.com/globus/react-auth-context/blob/dd4f18f00c59a4d730366bf281f83506ce9ff987/src/Provider.tsx#L14)
diff --git a/docs/variables/initialState.md b/docs/variables/initialState.md
@@ -10,4 +10,4 @@
 
 ## Defined in
 
-[State.ts:10](https://github.com/globus/react-auth-context/blob/f12539af272bb8ebd6d198a34aa9ee5c5ed146c2/src/State.ts#L10)
+[State.ts:10](https://github.com/globus/react-auth-context/blob/dd4f18f00c59a4d730366bf281f83506ce9ff987/src/State.ts#L10)