diff --git a/apps/sdk/README.md b/apps/sdk/README.md new file mode 100644 index 00000000..f77ce31d --- /dev/null +++ b/apps/sdk/README.md @@ -0,0 +1,24 @@ +# Postiz NodeJS SDK + +This is the NodeJS SDK for Postiz. + +You can start by installing the package: + +```bash +npm install @postiz/node +``` + +## Usage +```typescript +import Postiz from '@postiz/node'; +const postiz = new Postiz('your api key', 'your self-hosted instance (optional)'); +``` + +The available methods are: +- `post(posts: CreatePostDto)` - Schedule a post to Postiz +- `postList(filters: GetPostsDto)` - Get a list of posts +- `upload(file: Buffer, extension: string)` - Upload a file to Postiz +- `integrations()` - Get a list of connected channels +- `deletePost(id: string)` - Delete a post by ID + +Alternatively you can use the SDK with curl, check the [Postiz API documentation](https://docs.postiz.com/public-api) for more information. \ No newline at end of file diff --git a/apps/sdk/package.json b/apps/sdk/package.json index cc16baa1..453d5405 100644 --- a/apps/sdk/package.json +++ b/apps/sdk/package.json @@ -1,6 +1,6 @@ { "name": "@postiz/node", - "version": "1.0.0", + "version": "1.0.1", "description": "The Ultimate social media scheduling tool", "main": "dist/index.js", "types": "dist/index.d.ts",