diff --git a/README.md b/README.md index c7378dd..8f68ffd 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,13 @@ Non-official [Moises AI](https://developer.moises.ai/) API wrapper package with Typescript support +[![Codacy Badge](https://app.codacy.com/project/badge/Grade/3e0b2e2d5b9d4157a26d7faebe3f5a6f)](https://app.codacy.com/gh/leandrosimoes/moises/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) +[![npm version](https://badge.fury.io/js/moises-node.svg)](https://badge.fury.io/js/moises-node) +[![Node.js Package](https://github.com/leandrosimoes/moises/actions/workflows/npmpublish.yml/badge.svg)](https://github.com/leandrosimoes/moises/actions/workflows/npmpublish.yml) +[](https://lesimoes.slack.com/messages/C05GZ1F8P44) +[](https://discord.gg/wSr8t8p4Vr) + + ## Install `yarn add moises-node` @@ -13,10 +20,17 @@ or ## How to use it? ```typescript -import { processFile, processFolder } from 'moises-node' - -// types +// importing into your project +import { + processFile, + processFolder, + ProcessStatus, + ProcessFileOptions, + JobStatus, + DownloadResult +} from 'moises-node' +// types exported by the library export type ProcessStatus = | 'PENDING' | 'PROCESSING' @@ -70,7 +84,7 @@ export type DownloadResult = { [key: string]: string } -// functions +// functions exported by the library async function processFile({ apiKey, workflowId, diff --git a/package.json b/package.json index 4125c00..aa9ac1d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "moises-node", - "version": "1.0.3", + "version": "1.0.4", "description": "Non-official Moises AI (https://developer.moises.ai/) API wrapper package with Typescript support", "main": "dist/index.js", "typings": "dist/index.d.ts",