Skip to content

Commit c08bcdd

Browse files
committed
chore: adds some basic usage notes
1 parent c8456ef commit c08bcdd

File tree

1 file changed

+11
-20
lines changed

1 file changed

+11
-20
lines changed

README.md

Lines changed: 11 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,24 @@
1-
# Supabase JS
1+
# `supabase-js`
22

3-
## Commands
4-
- `npm run clean` - Remove `lib/` directory
5-
- `npm test` - Run tests with linting and coverage results.
6-
- `npm run test:integration` - Run the integration tests without docker (requires you to run the docker container separately)
7-
- `npm run test:integration:full` - Run the integration tests (requires docker to be running)
8-
- `npm test:only` - Run tests without linting or coverage.
9-
- `npm test:watch` - You can even re-run tests on file changes!
10-
- `npm test:prod` - Run tests with minified code.
11-
- `npm run test:examples` - Test written examples on pure JS for better understanding module usage.
12-
- `npm run lint` - Run ESlint with airbnb-config
13-
- `npm run cover` - Get coverage report for your code.
14-
- `npm run build` - Babel will transpile ES6 => ES5 and minify the code.
15-
- `npm run build:umd` - Babel will transpile ES6 => UMD, minify the code and webpack to supabase.js
16-
- `npm run prepublish` - Hook for npm. Do all the checks before publishing your module.
3+
An isomorphic Javascript client for Supabase.
174

5+
- Documentation: http://localhost:3005/docs/client/supabase-client
186

19-
## Publishing
20-
21-
Bump the semver.
7+
## Usage
228

239
```sh
24-
npm publish --access=public
10+
npm install @supabase/supabase-js
2511
```
2612

13+
```js
14+
import { createClient } from '@supabase/supabase-js'
15+
16+
// Create a single supabase client for interacting with your database
17+
const supabase = createClient('https://xyzcompany.supabase.co', 'public-anon-key')
18+
```
2719

2820
## Sponsors
2921

3022
We are building the features of Firebase using enterprise-grade, open source products. We support existing communities wherever possible, and if the products don’t exist we build them and open source them ourselves. Thanks to these sponsors who are making the OSS ecosystem better for everyone.
3123

32-
[![Worklife VC](https://user-images.githubusercontent.com/10214025/90451355-34d71200-e11e-11ea-81f9-1592fd1e9146.png)](https://www.worklife.vc)
3324
[![New Sponsor](https://user-images.githubusercontent.com/10214025/90518111-e74bbb00-e198-11ea-8f88-c9e3c1aa4b5b.png)](https://github.com/sponsors/supabase)

0 commit comments

Comments
 (0)