Skip to content

Commit

Permalink
feat: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
JesseTheRobot committed Sep 4, 2024
1 parent 1ce7049 commit aaa7330
Showing 1 changed file with 6 additions and 9 deletions.
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,26 @@
# ANS-104 Bundles

**If you want to use Bundlr Network head over to [this repo](https://github.com/Bundlr-Network/js-client)**
# Irys bundles
**If you want to use the Irys Network, head over to [our SDK](https://github.com/Irys-xyz/js-sdk)**

A low level library for creating, editing, reading and verifying bundles.

See [ANS-104](https://github.com/ArweaveTeam/arweave-standards/blob/master/ans/ANS-104.md) for more details.

## Installing the library

Using npm:

`npm install arbundles`
`npm install @irys/bundles`

Using yarn:

`yarn add arbundles`
`yarn add @irys/bundles`

## Creating bundles

```ts
import { bundleAndSignData, createData } from "arbundles";
import { bundleAndSignData, createData, EthereumSigner } from "@irys/bundles";

const dataItems = [createData("some data"), createData("some other data")];

const signer = new ArweaveSigner(jwk);
const signer = new EthereumSigner("privateKey")

const bundle = await bundleAndSignData(dataItems, signer);
```

0 comments on commit aaa7330

Please sign in to comment.