Skip to content

Commit

Permalink
fix: #153 Adds link to our docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kiwicopple authored Feb 9, 2021
1 parent 19d0fd9 commit 512bb34
Showing 1 changed file with 23 additions and 13 deletions.
36 changes: 23 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,30 @@ Isomorphic JavaScript client for [PostgREST](https://postgrest.org). The goal of
Ready for production! Watch and star this repo to keep updated on releases.

## Documentation
Visit our [wiki](https://github.com/supabase/postgrest-js/wiki) to get started!

## Usage online
Visit our [docs](https://supabase.io/docs/postgrest/client/postgrest-client) to get started!

### supabase/supabase-js
- [Repository](https://github.com/supabase/supabase-js)
- [Documentation](https://supabase.io/docs)
### Quick start

## Contributing
Install

- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- Submit a Pull request so that we can review your changes and merge
```
npm install @supabase/postgrest-js
```

Usage

```
import { PostgrestClient } from '@supabase/postgrest-js'
const REST_URL = 'http://localhost:3000'
const postgrest = new PostgrestClient(REST_URL)
```

- select(): https://supabase.io/docs/postgrest/client/select
- insert(): https://supabase.io/docs/postgrest/client/insert
- update(): https://supabase.io/docs/postgrest/client/update
- delete(): https://supabase.io/docs/postgrest/client/update

## License

Expand All @@ -33,12 +42,13 @@ This repo is liscenced under MIT.

- https://github.com/calebmer/postgrest-client - originally forked and adapted from @calebmer's library

![Watch this repo](https://gitcdn.xyz/repo/supabase/monorepo/master/web/static/watch-repo.gif "Watch this repo")


## Sponsors

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.

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


![Watch this repo](https://gitcdn.xyz/repo/supabase/monorepo/master/web/static/watch-repo.gif "Watch this repo")

0 comments on commit 512bb34

Please sign in to comment.