Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
adraffy committed Jan 15, 2024
1 parent 0c8ccd1 commit f982de6
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# cid.js
0-dependancy [Multiformat CID](https://github.com/multiformats/cid/blob/master/README.md).

* [`6KB`](./dist/index.min.js) **Default** — full library
* [`7KB`](./dist/index.min.js) **Default** — full library

```js
import {CID, Multibase} from '@adraffy/cid.js'; // or require()
Expand Down Expand Up @@ -40,16 +40,17 @@ cid1.toString(Multibase.for('z')); // use different base ("z" => base58btc)
// zdj7WXCTUquTeArWZZbaegbyYuz8mujpBZJkCQsfcvE458QR1
```

[Available bases](./src/bases.js#L60)

Available coders:
```js
import {
Base2, Base8, Base16, Base32, Base32Hex, Base32Z, Base64, Base64URL, // RFC4648
Base10, Base36, Base58BTC, Base58Flickr, // Prefix0
Bech32,
Base2, Base8, Base16, Base32, Base32Hex, Base32Z, Base64, Base64URL, // RFC4648
Base10, Base36, Base58BTC, Base58Flickr, // Prefix0
Bech32,
} from '@adraffy/cid.js';
```


### Build

* `git clone` this repo, then `npm install`
Expand Down

0 comments on commit f982de6

Please sign in to comment.