Skip to content

Commit b012a7f

Browse files
mandarinimandarini
committed
docs(repo): make all READMEs similar
1 parent c36af99 commit b012a7f

File tree

10 files changed

+124
-42
lines changed

10 files changed

+124
-42
lines changed

‎.cursorrules‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Cursor Rules for Supabase JS Libraries Monorepo
22

3-
You are working in a unified Nx monorepo that consolidates all Supabase JavaScript client libraries. This migration from 6 separate repositories addresses maintenance overhead, dependency duplication, and release coordination challenges.
3+
You are working in a unified Nx monorepo that consolidates all Supabase JavaScript SDKs. This migration from 6 separate repositories addresses maintenance overhead, dependency duplication, and release coordination challenges.
44

55
## Repository Context
66

‎CLAUDE.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Claude AI Instructions for Supabase JS Libraries Monorepo
22

3-
You are assisting with development in a unified Nx monorepo that consolidates all Supabase JavaScript client libraries, built with Nx for optimal developer experience and maintainability. This strategic migration from 6 separate repositories addresses critical maintenance overhead, dependency duplication, and release coordination challenges while maintaining **zero breaking changes** for consumers.
3+
You are assisting with development in a unified Nx monorepo that consolidates all Supabase JavaScript SDKs, built with Nx for optimal developer experience and maintainability. This strategic migration from 6 separate repositories addresses critical maintenance overhead, dependency duplication, and release coordination challenges while maintaining **zero breaking changes** for consumers.
44

55
> **📚 Essential Documentation**: Always refer to these guides for detailed information:
66
>
@@ -777,4 +777,4 @@ _No user-facing changes in this release._
777777
- Unchanged packages show "No user-facing changes"
778778
- Single npm install updates entire SDK suite
779779

780-
Remember: This monorepo optimizes for developer experience and maintenance efficiency while ensuring zero breaking changes for the millions of developers using Supabase client libraries.
780+
Remember: This monorepo optimizes for developer experience and maintenance efficiency while ensuring zero breaking changes for the millions of developers using Supabase SDKs.

‎docs/MIGRATION.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -325,7 +325,7 @@ Use these names with Nx commands:
325325
- `postgrest-js` - PostgREST library
326326
- `realtime-js` - Realtime library
327327
- `storage-js` - Storage library
328-
- `supabase-js` - Main client library
328+
- `supabase-js` - Main SDK
329329

330330
### Useful New Commands
331331

‎packages/core/auth-js/README.md‎

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,32 @@
1-
# `auth-js`
2-
3-
An isomorphic JavaScript SDK for the [Supabase Auth](https://github.com/supabase/auth) API.
1+
<br />
2+
<p align="center">
3+
<a href="https://supabase.io">
4+
<picture>
5+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/supabase/supabase/master/packages/common/assets/images/supabase-logo-wordmark--dark.svg">
6+
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/supabase/supabase/master/packages/common/assets/images/supabase-logo-wordmark--light.svg">
7+
<img alt="Supabase Logo" width="300" src="https://raw.githubusercontent.com/supabase/supabase/master/packages/common/assets/images/logo-preview.jpg">
8+
</picture>
9+
</a>
10+
11+
<h1 align="center">Supabase Auth JS SDK</h1>
12+
13+
<h3 align="center">An isomorphic JavaScript SDK for the <a href="https://github.com/supabase/auth">Supabase Auth</a> API.</h3>
14+
15+
<p align="center">
16+
<a href="https://supabase.com/docs/guides/auth">Guides</a>
17+
·
18+
<a href="https://supabase.com/docs/reference/javascript/auth-signup">Reference Docs</a>
19+
·
20+
<a href="https://supabase.github.io/supabase-js/auth-js/v2/spec.json">TypeDoc</a>
21+
</p>
22+
</p>
423

524
<div align="center">
625

726
[![pkg.pr.new](https://pkg.pr.new/badge/supabase/auth-js)](https://pkg.pr.new/~/supabase/auth-js)
827

928
</div>
1029

11-
## Docs
12-
13-
- Using `auth-js`: https://supabase.com/docs/reference/javascript/auth-signup
14-
- TypeDoc: https://supabase.github.io/supabase-js/auth-js/v2/spec.json
15-
1630
## Quick start
1731

1832
Install
@@ -31,9 +45,9 @@ const GOTRUE_URL = 'http://localhost:9999'
3145
const auth = new AuthClient({ url: GOTRUE_URL })
3246
```
3347

34-
- `signUp()`: https://supabase.io/docs/reference/javascript/auth-signup
35-
- `signIn()`: https://supabase.io/docs/reference/javascript/auth-signin
36-
- `signOut()`: https://supabase.io/docs/reference/javascript/auth-signout
48+
- `signUp()`: https://supabase.com/docs/reference/javascript/auth-signup
49+
- `signIn()`: https://supabase.com/docs/reference/javascript/auth-signin
50+
- `signOut()`: https://supabase.com/docs/reference/javascript/auth-signout
3751

3852
### Custom `fetch` implementation
3953

‎packages/core/auth-js/src/lib/error-codes.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* Known error codes. Note that the server may also return other error codes
3-
* not included in this list (if the client library is older than the version
3+
* not included in this list (if the SDK is older than the version
44
* on the server).
55
*/
66
export type ErrorCode =

‎packages/core/functions-js/README.md‎

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,32 @@
1-
# `functions-js`
1+
<br />
2+
<p align="center">
3+
<a href="https://supabase.io">
4+
<picture>
5+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/supabase/supabase/master/packages/common/assets/images/supabase-logo-wordmark--dark.svg">
6+
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/supabase/supabase/master/packages/common/assets/images/supabase-logo-wordmark--light.svg">
7+
<img alt="Supabase Logo" width="300" src="https://raw.githubusercontent.com/supabase/supabase/master/packages/common/assets/images/logo-preview.jpg">
8+
</picture>
9+
</a>
10+
11+
<h1 align="center">Supabase Functions JS SDK</h1>
12+
13+
<h3 align="center">JavaScript SDK to interact with Supabase Edge Functions.</h3>
14+
15+
<p align="center">
16+
<a href="https://supabase.com/docs/guides/functions">Guides</a>
17+
·
18+
<a href="https://supabase.com/docs/reference/javascript/functions-invoke">Reference Docs</a>
19+
·
20+
<a href="https://supabase.github.io/supabase-js/functions-js/v2/spec.json">TypeDoc</a>
21+
</p>
22+
</p>
223

324
<div align="center">
425

526
[![pkg.pr.new](https://pkg.pr.new/badge/supabase/functions-js)](https://pkg.pr.new/~/supabase/functions-js)
627

728
</div>
829

9-
JS SDK to interact with Supabase Functions.
10-
11-
## Docs
12-
13-
- **API Reference**: <https://supabase.com/docs/reference/javascript/functions-invoke>
14-
- **Functions Guide**: <https://supabase.com/docs/guides/functions>
15-
- **Typedoc**: <https://supabase.github.io/supabase-js/functions-js/v2/spec.json>
16-
1730
## Quick Start
1831

1932
### Installation

‎packages/core/postgrest-js/README.md‎

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,34 @@
1-
# `postgrest-js`
1+
<br />
2+
<p align="center">
3+
<a href="https://supabase.io">
4+
<picture>
5+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/supabase/supabase/master/packages/common/assets/images/supabase-logo-wordmark--dark.svg">
6+
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/supabase/supabase/master/packages/common/assets/images/supabase-logo-wordmark--light.svg">
7+
<img alt="Supabase Logo" width="300" src="https://raw.githubusercontent.com/supabase/supabase/master/packages/common/assets/images/logo-preview.jpg">
8+
</picture>
9+
</a>
10+
11+
<h1 align="center">Supabase PostgREST JS SDK</h1>
12+
13+
<h3 align="center">Isomorphic JavaScript SDK for <a href="https://postgrest.org">PostgREST</a> with an ORM-like interface.</h3>
14+
15+
<p align="center">
16+
<a href="https://supabase.com/docs/guides/database">Guides</a>
17+
·
18+
<a href="https://supabase.com/docs/reference/javascript/select">Reference Docs</a>
19+
·
20+
<a href="https://supabase.github.io/supabase-js/postgrest-js/v2/spec.json">TypeDoc</a>
21+
</p>
22+
</p>
23+
24+
<div align="center">
225

326
[![Build](https://github.com/supabase/postgrest-js/workflows/CI/badge.svg)](https://github.com/supabase/postgrest-js/actions?query=branch%3Amaster)
427
[![Package](https://img.shields.io/npm/v/@supabase/postgrest-js)](https://www.npmjs.com/package/@supabase/postgrest-js)
528
[![License: MIT](https://img.shields.io/npm/l/@supabase/postgrest-js)](#license)
629
[![pkg.pr.new](https://pkg.pr.new/badge/supabase/postgrest-js)](https://pkg.pr.new/~/supabase/postgrest-js)
730

8-
Isomorphic JavaScript SDK for [PostgREST](https://postgrest.org). The goal of this library is to make an "ORM-like" restful interface.
9-
10-
Full documentation can be found [here](https://supabase.github.io/supabase-js/postgrest-js/v2/spec.json).
31+
</div>
1132

1233
### Quick start
1334

@@ -167,7 +188,7 @@ It performs these steps:
167188
- **Port 3000** - PostgREST server (API)
168189
- **Port 8080** - Database schema endpoint (for type generation)
169190

170-
**Note:** Unlike a full Supabase instance, this uses a minimal PostgREST setup specifically for testing the client library.
191+
**Note:** Unlike a full Supabase instance, this uses a minimal PostgREST setup specifically for testing the SDK.
171192

172193
### Contributing
173194

‎packages/core/storage-js/README.md‎

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,32 @@
1-
# `storage-js`
1+
<br />
2+
<p align="center">
3+
<a href="https://supabase.io">
4+
<picture>
5+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/supabase/supabase/master/packages/common/assets/images/supabase-logo-wordmark--dark.svg">
6+
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/supabase/supabase/master/packages/common/assets/images/supabase-logo-wordmark--light.svg">
7+
<img alt="Supabase Logo" width="300" src="https://raw.githubusercontent.com/supabase/supabase/master/packages/common/assets/images/logo-preview.jpg">
8+
</picture>
9+
</a>
10+
11+
<h1 align="center">Supabase Storage JS SDK</h1>
12+
13+
<h3 align="center">JavaScript SDK to interact with Supabase Storage.</h3>
14+
15+
<p align="center">
16+
<a href="https://supabase.com/docs/guides/storage">Guides</a>
17+
·
18+
<a href="https://supabase.com/docs/reference/javascript/storage-createbucket">Reference Docs</a>
19+
·
20+
<a href="https://supabase.github.io/supabase-js/storage-js/v2/spec.json">TypeDoc</a>
21+
</p>
22+
</p>
223

324
<div align="center">
425

526
[![pkg.pr.new](https://pkg.pr.new/badge/supabase/storage-js)](https://pkg.pr.new/~/supabase/storage-js)
627

728
</div>
829

9-
JS SDK to interact with Supabase Storage.
10-
11-
- Documentation: https://supabase.io/docs/reference/javascript/storage-createbucket
12-
- Typedoc: https://supabase.github.io/supabase-js/storage-js/v2/spec.json
13-
1430
## Quick Start Guide
1531

1632
### Installing the module

‎packages/core/supabase-js/README.md‎

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,25 @@
1-
# `supabase-js` - Isomorphic JavaScript SDK for Supabase.
2-
3-
- **Documentation:** https://supabase.com/docs/reference/javascript/start
4-
- TypeDoc: https://supabase.github.io/supabase-js/supabase-js/v2/spec.json
1+
<br />
2+
<p align="center">
3+
<a href="https://supabase.io">
4+
<picture>
5+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/supabase/supabase/master/packages/common/assets/images/supabase-logo-wordmark--dark.svg">
6+
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/supabase/supabase/master/packages/common/assets/images/supabase-logo-wordmark--light.svg">
7+
<img alt="Supabase Logo" width="300" src="https://raw.githubusercontent.com/supabase/supabase/master/packages/common/assets/images/logo-preview.jpg">
8+
</picture>
9+
</a>
10+
11+
<h1 align="center">Supabase JS SDK</h1>
12+
13+
<h3 align="center">Isomorphic JavaScript SDK for Supabase - combining Auth, Database, Storage, Functions, and Realtime.</h3>
14+
15+
<p align="center">
16+
<a href="https://supabase.com/docs/guides/getting-started">Guides</a>
17+
·
18+
<a href="https://supabase.com/docs/reference/javascript/start">Reference Docs</a>
19+
·
20+
<a href="https://supabase.github.io/supabase-js/supabase-js/v2/spec.json">TypeDoc</a>
21+
</p>
22+
</p>
523

624
<div align="center">
725

‎packages/core/supabase-js/src/lib/types.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,9 +97,9 @@ export type SupabaseClientOptions<SchemaName> = {
9797
/**
9898
* Optional function for using a third-party authentication system with
9999
* Supabase. The function should return an access token or ID token (JWT) by
100-
* obtaining it from the third-party auth client library. Note that this
100+
* obtaining it from the third-party auth SDK. Note that this
101101
* function may be called concurrently and many times. Use memoization and
102-
* locking techniques if this is not supported by the client libraries.
102+
* locking techniques if this is not supported by the SDKs.
103103
*
104104
* When set, the `auth` namespace of the Supabase client cannot be used.
105105
* Create another client if you wish to use Supabase Auth and third-party

0 commit comments

Comments
 (0)