diff --git a/README.md b/README.md index a734c103..522fa061 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ ## Structure -- [`/packages/interop`](./packages/interop) Interop tests for @helia/unixfs +- [`/packages/interop`](./packages/interop) Interop tests for @helia/strings - [`/packages/strings`](./packages/strings) Add/get IPLD blocks containing strings with your Helia node ## API Docs diff --git a/packages/interop/README.md b/packages/interop/README.md index cf65d0f8..473db66f 100644 --- a/packages/interop/README.md +++ b/packages/interop/README.md @@ -11,7 +11,7 @@ [![codecov](https://img.shields.io/codecov/c/github/ipfs/helia-strings.svg?style=flat-square)](https://codecov.io/gh/ipfs/helia-strings) [![CI](https://img.shields.io/github/actions/workflow/status/ipfs/helia-strings/js-test-and-release.yml?branch=main\&style=flat-square)](https://github.com/ipfs/helia-strings/actions/workflows/js-test-and-release.yml?query=branch%3Amain) -> Interop tests for @helia/unixfs +> Interop tests for @helia/strings ## Table of contents @@ -24,20 +24,20 @@ ## Install ```console -$ npm i @helia/unixfs-interop +$ npm i @helia/strings-interop ``` ### Browser ` + ``` ## API Docs -- +- ## License diff --git a/packages/strings/CHANGELOG.md b/packages/strings/CHANGELOG.md index e00510b6..e69de29b 100644 --- a/packages/strings/CHANGELOG.md +++ b/packages/strings/CHANGELOG.md @@ -1,83 +0,0 @@ -## [@helia/unixfs-v1.2.1](https://github.com/ipfs/helia-unixfs/compare/@helia/unixfs-v1.2.0...@helia/unixfs-v1.2.1) (2023-03-23) - - -### Dependencies - -* update helia deps to v1 ([#16](https://github.com/ipfs/helia-unixfs/issues/16)) ([7497590](https://github.com/ipfs/helia-unixfs/commit/74975903ec619a4662e5bfa9546997641e9f8e8c)) - -## [@helia/unixfs-v1.2.0](https://github.com/ipfs/helia-unixfs/compare/@helia/unixfs-v1.1.0...@helia/unixfs-v1.2.0) (2023-03-17) - - -### Features - -* expose unixfs progress events in types ([#14](https://github.com/ipfs/helia-unixfs/issues/14)) ([36cf3b2](https://github.com/ipfs/helia-unixfs/commit/36cf3b2143276a59b685ceb58299c4f881545fee)) - -## [@helia/unixfs-v1.1.0](https://github.com/ipfs/helia-unixfs/compare/@helia/unixfs-v1.0.5...@helia/unixfs-v1.1.0) (2023-03-15) - - -### Features - -* expose progress events from importer, blockstore and bitswap ([#13](https://github.com/ipfs/helia-unixfs/issues/13)) ([de78f4d](https://github.com/ipfs/helia-unixfs/commit/de78f4d03ebafe9ed9a2dfcbfb7a516fa215585c)) - - -### Trivial Changes - -* add interop test suite ([#12](https://github.com/ipfs/helia-unixfs/issues/12)) ([3ad5f5d](https://github.com/ipfs/helia-unixfs/commit/3ad5f5d8199a5596aa333916d4a240584bc0842a)) - -## [1.0.5](https://github.com/ipfs/helia-unixfs/compare/v1.0.4...v1.0.5) (2023-03-14) - - -### Bug Fixes - -* align defaults with filecoin ([#6](https://github.com/ipfs/helia-unixfs/issues/6)) ([a6bd198](https://github.com/ipfs/helia-unixfs/commit/a6bd1983bd7baac21af3de6fa269219f52664cde)) - -## [1.0.4](https://github.com/ipfs/helia-unixfs/compare/v1.0.3...v1.0.4) (2023-02-27) - - -### Bug Fixes - -* simplify shard handling ([#5](https://github.com/ipfs/helia-unixfs/issues/5)) ([52d4786](https://github.com/ipfs/helia-unixfs/commit/52d4786831c3b2b60322de562b752ecfbc8791bb)) - -## [1.0.3](https://github.com/ipfs/helia-unixfs/compare/v1.0.2...v1.0.3) (2023-02-25) - - -### Bug Fixes - -* enable last shard tests ([#4](https://github.com/ipfs/helia-unixfs/issues/4)) ([9774460](https://github.com/ipfs/helia-unixfs/commit/97744606d6da2e61a1aefa6af8f0f3b68f8827ab)) - -## [1.0.2](https://github.com/ipfs/helia-unixfs/compare/v1.0.1...v1.0.2) (2023-02-24) - - -### Bug Fixes - -* add methods to import data ([#3](https://github.com/ipfs/helia-unixfs/issues/3)) ([917a564](https://github.com/ipfs/helia-unixfs/commit/917a564c0d990dfd35d4615436fc8e3609c72a76)) - - -### Tests - -* move test file data to fixtures ([1b76084](https://github.com/ipfs/helia-unixfs/commit/1b760847a18b7b7c1e3fa8c871fd75acb298480b)) - -## [1.0.1](https://github.com/ipfs/helia-unixfs/compare/v1.0.0...v1.0.1) (2023-02-17) - - -### Bug Fixes - -* update unixfs importer ([f6edeca](https://github.com/ipfs/helia-unixfs/commit/f6edeca471da4aaa2171b0b3f2d2ea91d527a00e)) - -## 1.0.0 (2023-02-16) - - -### Features - -* initial implementation ([#1](https://github.com/ipfs/helia-unixfs/issues/1)) ([adb6b0e](https://github.com/ipfs/helia-unixfs/commit/adb6b0e2626a3bdd08cdc4445e3367f104bc5bb8)) - - -### Trivial Changes - -* initial commit ([35e8a8f](https://github.com/ipfs/helia-unixfs/commit/35e8a8fd7c1ca68b21320b95211304bf01b30086)) -* Update .github/workflows/stale.yml [skip ci] ([bcb060d](https://github.com/ipfs/helia-unixfs/commit/bcb060d880175ab885479388049a1ca2e5873629)) - - -### Documentation - -* update readme ([83e5e0e](https://github.com/ipfs/helia-unixfs/commit/83e5e0e0ccfd27f9371c9a8940c237e398e9b68f)) diff --git a/packages/strings/src/index.ts b/packages/strings/src/index.ts index 9006dd6d..df7ae5ef 100644 --- a/packages/strings/src/index.ts +++ b/packages/strings/src/index.ts @@ -63,7 +63,7 @@ export interface Strings { * const cid = await str.add('hello world') * * console.info(cid) - * // CID(QmFoo) + * // CID(bafkreifzjut3te2nhyekklss27nh3k72ysco7y32koao5eei66wof36n5e) * ``` */ add: (str: string, options?: Partial) => Promise @@ -79,7 +79,7 @@ export interface Strings { * import { CID } from 'multiformats/cid' * * const str = strings(helia) - * const cid = CID.parse('') + * const cid = CID.parse('bafkreifzjut3te2nhyekklss27nh3k72ysco7y32koao5eei66wof36n5e') * const string = await str.get(cid) * * console.info(string)