Skip to content

Commit 1d76de6

Browse files
Merge pull request #12 from doyoonkim12345/feature/code-signing
docs: update README
2 parents 602d41e + 1c342fd commit 1d76de6

File tree

1 file changed

+65
-87
lines changed

1 file changed

+65
-87
lines changed

Readme.md

Lines changed: 65 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22
<img src="./logo.png" alt="Logo" width="300" />
33
</p>
44

5-
[![@cloud-push/cloud](https://img.shields.io/badge/@cloud--push/cloud-v1.1.0-blue)](https://www.npmjs.com/package/@cloud-push/cloud)
6-
[![@cloud-push/expo](https://img.shields.io/badge/@cloud--push/expo-v1.1.0-blue)](https://www.npmjs.com/package/@cloud-push/expo)
7-
[![@cloud-push/next](https://img.shields.io/badge/@cloud--push/next-v1.1.0-blue)](https://www.npmjs.com/package/@cloud-push/next)
8-
[![@cloud-push/cli](https://img.shields.io/badge/@cloud--push/cli-v1.1.0-blue)](https://www.npmjs.com/package/@cloud-push/expo)
9-
[![@cloud-push/utils](https://img.shields.io/badge/@cloud--push/utils-v1.1.0-blue)](https://www.npmjs.com/package/@cloud-push/next)
5+
[![@cloud-push/cloud](https://img.shields.io/badge/@cloud--push/cloud-v1.1.1-blue)](https://www.npmjs.com/package/@cloud-push/cloud)
6+
[![@cloud-push/expo](https://img.shields.io/badge/@cloud--push/expo-v1.1.1-blue)](https://www.npmjs.com/package/@cloud-push/expo)
7+
[![@cloud-push/next](https://img.shields.io/badge/@cloud--push/next-v1.1.1-blue)](https://www.npmjs.com/package/@cloud-push/next)
8+
[![@cloud-push/cli](https://img.shields.io/badge/@cloud--push/cli-v1.1.1-blue)](https://www.npmjs.com/package/@cloud-push/expo)
9+
[![@cloud-push/utils](https://img.shields.io/badge/@cloud--push/utils-v1.1.1-blue)](https://www.npmjs.com/package/@cloud-push/next)
10+
11+
## **Typescript Only, Zero kotlin, Zero Swift, Zero java, Zero Object-C**
1012

1113
**OTA Update solution compatible with Expo Updates**
1214
→ Self-hosted update distribution system
@@ -44,109 +46,85 @@ It follows [Expo Updates technical specs](https://docs.expo.dev/technical-specs/
4446
### Supabase
4547

4648
```ts
47-
import { defineConfig } from "@cloud-push/expo";
49+
import { defineConfig } from "@cloud-push/cli";
4850
import { SupabaseStorageClient, SupabaseDbClient } from "@cloud-push/cloud";
49-
import version from "./version";
50-
51-
const storageClient = new SupabaseStorageClient({
52-
bucketName: process.env.SUPABASE_BUCKET_NAME!,
53-
supabaseUrl: process.env.SUPABASE_URL!,
54-
supabaseKey: process.env.SUPABASE_KEY!,
55-
});
56-
57-
const dbClient = new SupabaseDbClient({
58-
tableName: process.env.SUPABASE_TABLE_NAME!,
59-
supabaseUrl: process.env.SUPABASE_URL!,
60-
supabaseKey: process.env.SUPABASE_KEY!,
61-
});
6251

6352
export default defineConfig(() => ({
64-
runtimeVersion: version.runtimeVersion,
65-
storage: storageClient,
66-
db: dbClient,
53+
loadClients: () => {
54+
55+
const storageClient = new SupabaseStorageClient({
56+
bucketName: process.env.SUPABASE_BUCKET_NAME!,
57+
supabaseUrl: process.env.SUPABASE_URL!,
58+
supabaseKey: process.env.SUPABASE_KEY!,
59+
});
60+
61+
const dbClient = new SupabaseDbClient({
62+
tableName: process.env.SUPABASE_TABLE_NAME!,
63+
supabaseUrl: process.env.SUPABASE_URL!,
64+
supabaseKey: process.env.SUPABASE_KEY!,
65+
});
66+
67+
return {
68+
storage: storageClient,
69+
db: dbClient,
70+
};
71+
},
6772
}));
6873
```
6974

7075
### AWS S3 + lowdb
7176

7277
```ts
73-
import { defineConfig } from "@cloud-push/expo";
78+
import { defineConfig } from "@cloud-push/cli";
7479
import { AWSS3StorageClient, LowDbClient } from "@cloud-push/cloud";
75-
import version from "./version";
76-
77-
const storageClient = new AWSS3StorageClient({
78-
accessKeyId: process.env.AWS_ACCESS_KEY_ID!,
79-
bucketName: process.env.AWS_BUCKET_NAME!,
80-
region: process.env.AWS_REGION!,
81-
secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY!,
82-
});
83-
84-
const dbClient = new LowDbClient({
85-
downloadJSONFile: () => storageClient.getFile({ key: "cursor.json" }),
86-
uploadJSONFile: (file: Uint8Array) =>
87-
storageClient.uploadFile({ key: "cursor.json", file }),
88-
});
8980

9081
export default defineConfig(() => ({
91-
runtimeVersion: version.runtimeVersion,
92-
storage: storageClient,
93-
db: dbClient,
82+
loadClients: () => {
83+
84+
const storageClient = new AWSS3StorageClient({
85+
accessKeyId: process.env.AWS_ACCESS_KEY_ID!,
86+
bucketName: process.env.AWS_BUCKET_NAME!,
87+
region: process.env.AWS_REGION!,
88+
secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY!,
89+
});
90+
91+
const dbClient = new LowDbClient({
92+
downloadJSONFile: () => storageClient.getFile({ key: "cursor.json" }),
93+
uploadJSONFile: (file: Uint8Array) =>
94+
storageClient.uploadFile({ key: "cursor.json", file }),
95+
});
96+
97+
return {
98+
storage: storageClient,
99+
db: dbClient,
100+
};
101+
},
94102
}));
95103
```
96104

97105
### Firebase
98106

99107
```ts
100-
import { defineConfig } from "@cloud-push/expo";
108+
import { defineConfig } from "@cloud-push/cli";
101109
import { FirebaseStorageClient, FirebaseDbClient } from "@cloud-push/cloud";
102-
import version from "./version";
103-
104-
const storageClient = new FirebaseStorageClient({
105-
credential: process.env.FIREBASE_CREDENTIAL!,
106-
bucketName: process.env.FIREBASE_BUCKET_NAME!,
107-
});
108-
109-
const dbClient = new FirebaseDbClient({
110-
credential: process.env.FIREBASE_CREDENTIAL!,
111-
databaseId: process.env.FIREBASE_DATABASE_ID!,
112-
});
113-
114-
export default defineConfig(() => ({
115-
runtimeVersion: version.runtimeVersion,
116-
storage: storageClient,
117-
db: dbClient,
118-
}));
119-
```
120-
121-
### Custom
122-
123-
```ts
124-
import { defineConfig } from "@cloud-push/expo";
125-
import { StorageClient, DbClient } from "@cloud-push/cloud";
126-
import version from "./version";
127-
128-
const storageClient: StorageClient = {
129-
getFile: () => {},
130-
getFileSignedUrl: () => {},
131-
uploadDirectory: () => {},
132-
uploadFile: () => {},
133-
uploadLocalFile: () => {},
134-
};
135-
136-
const dbClient: DbClient = {
137-
create: () => {},
138-
delete: () => {},
139-
find: () => {},
140-
findAll: () => {},
141-
readAll: () => {},
142-
toUint8Array: () => {},
143-
update: () => {},
144-
};
145110

146111
export default defineConfig(() => ({
147-
runtimeVersion: version.runtimeVersion,
148-
storage: storageClient,
149-
db: dbClient,
112+
loadClients: () => {
113+
const storageClient = new FirebaseStorageClient({
114+
credential: process.env.FIREBASE_CREDENTIAL!,
115+
bucketName: process.env.BUCKET_NAME!,
116+
});
117+
118+
const dbClient = new FirebaseDbClient({
119+
credential: process.env.FIREBASE_CREDENTIAL!,
120+
databaseId: process.env.FIREBASE_DATABASE_ID!,
121+
});
122+
123+
return {
124+
storage: storageClient,
125+
db: dbClient,
126+
};
127+
},
150128
}));
151129
```
152130

0 commit comments

Comments
 (0)