Skip to content

Commit

Permalink
feat: added readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sk1122 committed Oct 26, 2023
1 parent 068d013 commit 3682f16
Showing 1 changed file with 49 additions and 0 deletions.
49 changes: 49 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# fetcch.ts

[![Build Status](https://travis-ci.org/joemccann/dillinger.svg?branch=master)](https://travis-ci.org/joemccann/dillinger)

Fetcch is the first pull payments layer for blockchain, this SDK will enable anyone to

## Features


- create/get/update multichain identities
- create/get/resolve crosschain transaction requests (pull payments)
- create/get/add/remove contacts from circles (address books)
- utility functions for signatures, encoding, decoding etc
- ✨Magic ✨

fetcch.ts is a lightweight library that enables developer to use Fetcch in a more easier way.

## Important Links
- [Website](https://fetcch.xyz)
- [Docs](https://docs.fetcch.xyz)
- [SDK Docs](https://docs.fetcch.xyz)

## Installation

```sh
npm i @fetcch/sdk

yarn add @fetcch/sdk

pnpm i @fetcch/sdk
```

## Usage

### Initialize

```ts
import Fetcch from "@fetcch/sdk"

const fetcch = new Fetcch("SECRET_KEY")

const identity = fetcch.identity.create(IDENTITY_DATA)

const request = fetcch.request.create(REQUEST_DATA)

const circle = fetcch.addressBook.create(ADDRESS_BOOK_DATA)
```

For more info, checkout our [Docs](https://docs.fetcch.xyz)

0 comments on commit 3682f16

Please sign in to comment.