Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update readme #82

Merged
merged 1 commit into from
Dec 11, 2023
Merged

update readme #82

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
# ainize-sdk
# ainize-js

A Typescript SDK for the Ainize, a system for running AI services on the AI Network.
A Typescript JS for the Ainize, a system for running AI services on the AI Network.

## Requirements
node >= 16

## usage
### Install
```bash
npm install @ainize-team/ainize-sdk
npm install @ainize-team/ainize-js

yarn install @ainize-team/ainize-sdk
yarn install @ainize-team/ainize-js
```

### Import
```typescript
import Ainize from '@ainize-team/ainize-sdk'
import Ainize from '@ainize-team/ainize-js'
const ainize = new Ainize(<CHAIN_ID>);
```

Expand Down Expand Up @@ -49,9 +49,9 @@ service.run();
```

### Using Service
You can use a service using `ainize.service(<SERVICE_NAME>)`.
You can use a service using `ainize.getService(<SERVICE_NAME>)`.
```typescript
const service = await ainize.service(<SERVICE_NAME>);
const service = await ainize.getService(<SERVICE_NAME>);
```

You should deposit AIN to credit before using service.
Expand Down