Skip to content

Commit 5585cd5

Browse files
committed
chore(docs): Add README
1 parent b0d6912 commit 5585cd5

File tree

4 files changed

+37
-22
lines changed

4 files changed

+37
-22
lines changed

.github/workflows/codecov_test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Codecov test main
1+
name: Test
22

33
on:
44
push:

.github/workflows/create_release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ jobs:
3535
git config --global user.name "${{ github.event.sender.login }}"
3636
3737
- name: Apply standard-version
38-
run: standard-version -t "" --no-verify
38+
run: standard-version -t "" --no-verify --first-release
3939

4040
- name: Get new version
4141
id: version

README.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22
<a href="https://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo_text.svg" width="200" alt="Nest Logo" /></a><br /><a href="https://supabase.com/" target="blank"><img src="https://user-images.githubusercontent.com/8291514/213727225-56186826-bee8-43b5-9b15-86e839d89393.png#gh-dark-mode-only" width="500" alt="Supabase"></a>
33
</p>
44

5+
![Test](https://github.com/adrianmjim/nestjs-supabase-js/actions/workflows/codecov_test.yml/badge.svg)
6+
[![codecov](https://codecov.io/gh/Adrianmjim/nestjs-supabase-js/graph/badge.svg?token=jNHEDepqm7)](https://codecov.io/gh/Adrianmjim/nestjs-supabase-js)
7+
[![NPM Version](https://badge.fury.io/js/nestjs-supabase-js.svg?style=flat)](https://npmjs.org/package/nestjs-supabase-js)
8+
[![NPM Download Stats](https://nodei.co/npm/nestjs-supabase-js.png?downloads=true)](https://www.npmjs.com/package/nestjs-supabase-js)
9+
510
## Description
611

712
The [Supabase](https://github.com/supabase/supabase-js) module for [NestJS](https://github.com/nestjs/nest).
@@ -12,17 +17,17 @@ First install the dependencies via `npm`, `pnpm` or `yarn`:
1217

1318
npm:
1419
```bash
15-
$ npm i -s @nest/common @supabase/supabase-js nest-supabase
20+
$ npm i -s @nest/common @supabase/supabase-js nest-supabase-js
1621
```
1722

1823
pnpm:
1924
```bash
20-
$ pnpm add @nest/common @supabase/supabase-js nest-supabase
25+
$ pnpm add @nest/common @supabase/supabase-js nest-supabase-js
2126
```
2227

2328
yarn:
2429
```bash
25-
$ yarn add @nest/common @supabase/supabase-js nest-supabase
30+
$ yarn add @nest/common @supabase/supabase-js nest-supabase-js
2631
```
2732

2833
## Configuration
@@ -31,7 +36,7 @@ First, import the module into your NestJS application and configure it using the
3136

3237
```typescript
3338
import { Module } from '@nestjs/common';
34-
import { SupabaseModule } from 'nestjs-supabase';
39+
import { SupabaseModule } from 'nestjs-supabase-js';
3540

3641
@Module({
3742
imports: [
@@ -48,7 +53,7 @@ Or, You can configure it asynchronously as follows:
4853

4954
```typescript
5055
import { Module } from '@nestjs/common';
51-
import { SupabaseModule } from 'nestjs-supabase';
56+
import { SupabaseModule } from 'nestjs-supabase-js';
5257

5358
@Module({
5459
imports: [
@@ -71,7 +76,7 @@ In certain situations, we will need to connect to different Supabase projects, w
7176

7277
```typescript
7378
import { Module } from '@nestjs/common';
74-
import { SupabaseModule } from 'nestjs-supabase';
79+
import { SupabaseModule } from 'nestjs-supabase-js';
7580

7681
@Module({
7782
imports: [
@@ -100,7 +105,7 @@ Or asynchronously:
100105

101106
```typescript
102107
import { Module } from '@nestjs/common';
103-
import { SupabaseModule } from 'nestjs-supabase';
108+
import { SupabaseModule } from 'nestjs-supabase-js';
104109

105110
@Module({
106111
imports: [
@@ -135,7 +140,7 @@ First, inject the client into the module where you want to use it:
135140

136141
```typescript
137142
import { Module } from '@nestjs/common';
138-
import { SupabaseModule } from 'nestjs-supabase';
143+
import { SupabaseModule } from 'nestjs-supabase-js';
139144

140145
@Module({
141146
imports: [
@@ -149,7 +154,7 @@ Or, for a specific connection:
149154

150155
```typescript
151156
import { Module } from '@nestjs/common';
152-
import { SupabaseModule } from 'nestjs-supabase';
157+
import { SupabaseModule } from 'nestjs-supabase-js';
153158

154159
@Module({
155160
imports: [
@@ -177,7 +182,7 @@ Or, for a specific connection:
177182

178183
```typescript
179184
import { SupabaseClient } from '@supabase/supabase-js';
180-
import { InjectSupabaseClient } from 'nestjs-supabase';
185+
import { InjectSupabaseClient } from 'nestjs-supabase-js';
181186

182187
export class CatService {
183188
constructor(
@@ -195,7 +200,7 @@ It's also possible to use the InjectSupabaseClient decorator to inject the Supab
195200

196201
```typescript
197202
import { SupabaseClient } from '@supabase/supabase-js';
198-
import { InjectSupabaseClient } from 'nestjs-supabase';
203+
import { InjectSupabaseClient } from 'nestjs-supabase-js';
199204

200205
export class CatService {
201206
constructor(
@@ -208,7 +213,7 @@ export class CatService {
208213
}
209214
```
210215

211-
## 🤝 Contributing
216+
## 🤝 Contributing [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/adrianmjim/nestjs-supabase-js/issues)
212217

213218
Contributions, issues and feature requests are welcome.
214219

@@ -218,7 +223,7 @@ Contributions, issues and feature requests are welcome.
218223

219224
- Github: [@adrianmjim](https://github.com/adrianmjim)
220225

221-
See also the list of contributors who [participated](https://github.com/adrianmjim/nestjs-supabase/contributors) in this project.
226+
See also the list of contributors who [participated](https://github.com/adrianmjim/nestjs-supabase-js/contributors) in this project.
222227

223228
## Show Your Support
224229

package.json

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,32 @@
11
{
2-
"name": "nestjs-supabase",
3-
"version": "0.0.1",
4-
"description": "meow meow meow",
2+
"name": "nestjs-supabase-js",
3+
"version": "1.0.0",
4+
"description": "NestJS Supabase integration",
55
"keywords": [
66
"nestjs",
77
"supabase",
8-
"module"
8+
"supabase-js",
9+
"module",
10+
"supabase-auth",
11+
"supabase-db",
12+
"database",
13+
"auth",
14+
"authentication",
15+
"postgres",
16+
"supabase-storage",
17+
"supabase-realtime",
18+
"storage"
919
],
1020
"author": "Adrián Martínez Jiménez <adrianmjim199434@gmail.com>",
11-
"homepage": "https://github.com/adrianmjim/nestjs-supabase#readme",
21+
"homepage": "https://github.com/adrianmjim/nestjs-supabase-js#readme",
1222
"license": "ISC",
1323
"main": "lib/index.js",
1424
"repository": {
1525
"type": "git",
16-
"url": "git+https://github.com/adrianmjim/nestjs-supabase.git"
26+
"url": "git+https://github.com/adrianmjim/nestjs-supabase-js.git"
1727
},
1828
"bugs": {
19-
"url": "https://github.com/adrianmjim/nestjs-supabase/issues"
29+
"url": "https://github.com/adrianmjim/nestjs-supabase-js/issues"
2030
},
2131
"devDependencies": {
2232
"@jest/globals": "29.7.0",

0 commit comments

Comments
 (0)