Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pgoos committed Jul 9, 2024
1 parent fddef01 commit 8c7afe3
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
# gtk-api
# @sifchain/gtk-api

The `gtk-api` package provides a wrapper for the internal API client to manage and execute trade operations. This README will guide you through the installation, usage, and API methods available in the package.
The `@sifchain/gtk-api` package provides a wrapper for the internal API client to manage and execute trade operations. This README will guide you through the installation, usage, and API methods available in the package.

## Installation

To install the `gtk-api` package, use the following command:
To install the `@sifchain/gtk-api` package, use the following command:

```bash
yarn add gtk-api
yarn add @sifchain/gtk-api

```

OR

```bash
npm install gtk-api
npm install @sifchain/gtk-api

```

# Sample Repo

Clone sample [repo](https://github.com/monilpat/gtk-api-sample) to use the API without having to create any boilerplate
Clone sample [repo](https://github.com/Sifchain/gtk-api-sample) to use the API without having to create any boilerplate

# Usage

Expand All @@ -31,7 +31,7 @@ currently only mainnet network is configured for API usage.

```typescript
import { DirectSecp256k1HdWallet } from "@cosmjs/proto-signing";
import { APIClientWrapper } from "gtk-api";
import { APIClientWrapper } from "@sifchain/gtk-api";

async function main() {
const wallet = await DirectSecp256k1HdWallet.fromMnemonic("your-mnemonic");
Expand Down Expand Up @@ -259,7 +259,7 @@ import {
PnlTypeEnum,
TradeDirectionEnum,
TradeStatusEnum,
} from "gtk-api";
} from "@sifchain/gtk-api";
import { DirectSecp256k1HdWallet } from "@cosmjs/proto-signing";

export async function main() {
Expand Down
2 changes: 1 addition & 1 deletion src/sampleAPIClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
// TargetTokenType,
// CollateralTokenType,
// DirectSecp256k1HdWallet,
// } from "gtk-api";
// } from "@sifchain/gtk-api";

export async function main() {
// // Initialize the APIClientWrapper
Expand Down

0 comments on commit 8c7afe3

Please sign in to comment.