Skip to content

Commit

Permalink
Update README.md with installation and usage instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
oconr committed Feb 28, 2024
1 parent f669367 commit b6a339f
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@

This is a package that creates a fully typed SDK based on your Appwrite collections

- Build using `npm run build`
> Install using `npm install apptyped`
- Create `.env` with the following:
- `APPWRITE_ENDPOINT` - The endpoint of your Appwrite instance
- `APPWRITE_PROJECT_ID` - The ID of your Appwrite project
- `APPWRITE_API_KEY` - An Appwrite API key is required to generate the types from your collections as well as using the server-side client
- Run `node lib/index g` to generate the fully typed SDK
- Run `npx apptyped g` to generate the fully typed SDK

> This SDK is compatible with Appwrite server version 1.4.x
Expand Down

0 comments on commit b6a339f

Please sign in to comment.