Skip to content
This repository was archived by the owner on Feb 28, 2024. It is now read-only.

Commit c62f784

Browse files
authored
docs: update readme (#6)
Remove old references
1 parent 22d3900 commit c62f784

File tree

4 files changed

+8
-91
lines changed

4 files changed

+8
-91
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222

2323
## Structure
2424

25-
- [`/packages/interop`](./packages/interop) Interop tests for @helia/unixfs
25+
- [`/packages/interop`](./packages/interop) Interop tests for @helia/strings
2626
- [`/packages/strings`](./packages/strings) Add/get IPLD blocks containing strings with your Helia node
2727

2828
## API Docs

packages/interop/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
[![codecov](https://img.shields.io/codecov/c/github/ipfs/helia-strings.svg?style=flat-square)](https://codecov.io/gh/ipfs/helia-strings)
1212
[![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)
1313

14-
> Interop tests for @helia/unixfs
14+
> Interop tests for @helia/strings
1515
1616
## Table of contents <!-- omit in toc -->
1717

@@ -24,20 +24,20 @@
2424
## Install
2525

2626
```console
27-
$ npm i @helia/unixfs-interop
27+
$ npm i @helia/strings-interop
2828
```
2929

3030
### Browser `<script>` tag
3131

32-
Loading this module through a script tag will make it's exports available as `HeliaUnixfsInterop` in the global namespace.
32+
Loading this module through a script tag will make it's exports available as `HeliaStringsInterop` in the global namespace.
3333

3434
```html
35-
<script src="https://unpkg.com/@helia/unixfs-interop/dist/index.min.js"></script>
35+
<script src="https://unpkg.com/@helia/strings-interop/dist/index.min.js"></script>
3636
```
3737

3838
## API Docs
3939

40-
- <https://ipfs.github.io/helia-strings/modules/_helia_unixfs_interop.html>
40+
- <https://ipfs.github.io/helia-strings/modules/_helia_strings_interop.html>
4141

4242
## License
4343

packages/strings/CHANGELOG.md

-83
Original file line numberDiff line numberDiff line change
@@ -1,83 +0,0 @@
1-
## [@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)
2-
3-
4-
### Dependencies
5-
6-
* update helia deps to v1 ([#16](https://github.com/ipfs/helia-unixfs/issues/16)) ([7497590](https://github.com/ipfs/helia-unixfs/commit/74975903ec619a4662e5bfa9546997641e9f8e8c))
7-
8-
## [@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)
9-
10-
11-
### Features
12-
13-
* expose unixfs progress events in types ([#14](https://github.com/ipfs/helia-unixfs/issues/14)) ([36cf3b2](https://github.com/ipfs/helia-unixfs/commit/36cf3b2143276a59b685ceb58299c4f881545fee))
14-
15-
## [@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)
16-
17-
18-
### Features
19-
20-
* 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))
21-
22-
23-
### Trivial Changes
24-
25-
* add interop test suite ([#12](https://github.com/ipfs/helia-unixfs/issues/12)) ([3ad5f5d](https://github.com/ipfs/helia-unixfs/commit/3ad5f5d8199a5596aa333916d4a240584bc0842a))
26-
27-
## [1.0.5](https://github.com/ipfs/helia-unixfs/compare/v1.0.4...v1.0.5) (2023-03-14)
28-
29-
30-
### Bug Fixes
31-
32-
* align defaults with filecoin ([#6](https://github.com/ipfs/helia-unixfs/issues/6)) ([a6bd198](https://github.com/ipfs/helia-unixfs/commit/a6bd1983bd7baac21af3de6fa269219f52664cde))
33-
34-
## [1.0.4](https://github.com/ipfs/helia-unixfs/compare/v1.0.3...v1.0.4) (2023-02-27)
35-
36-
37-
### Bug Fixes
38-
39-
* simplify shard handling ([#5](https://github.com/ipfs/helia-unixfs/issues/5)) ([52d4786](https://github.com/ipfs/helia-unixfs/commit/52d4786831c3b2b60322de562b752ecfbc8791bb))
40-
41-
## [1.0.3](https://github.com/ipfs/helia-unixfs/compare/v1.0.2...v1.0.3) (2023-02-25)
42-
43-
44-
### Bug Fixes
45-
46-
* enable last shard tests ([#4](https://github.com/ipfs/helia-unixfs/issues/4)) ([9774460](https://github.com/ipfs/helia-unixfs/commit/97744606d6da2e61a1aefa6af8f0f3b68f8827ab))
47-
48-
## [1.0.2](https://github.com/ipfs/helia-unixfs/compare/v1.0.1...v1.0.2) (2023-02-24)
49-
50-
51-
### Bug Fixes
52-
53-
* add methods to import data ([#3](https://github.com/ipfs/helia-unixfs/issues/3)) ([917a564](https://github.com/ipfs/helia-unixfs/commit/917a564c0d990dfd35d4615436fc8e3609c72a76))
54-
55-
56-
### Tests
57-
58-
* move test file data to fixtures ([1b76084](https://github.com/ipfs/helia-unixfs/commit/1b760847a18b7b7c1e3fa8c871fd75acb298480b))
59-
60-
## [1.0.1](https://github.com/ipfs/helia-unixfs/compare/v1.0.0...v1.0.1) (2023-02-17)
61-
62-
63-
### Bug Fixes
64-
65-
* update unixfs importer ([f6edeca](https://github.com/ipfs/helia-unixfs/commit/f6edeca471da4aaa2171b0b3f2d2ea91d527a00e))
66-
67-
## 1.0.0 (2023-02-16)
68-
69-
70-
### Features
71-
72-
* initial implementation ([#1](https://github.com/ipfs/helia-unixfs/issues/1)) ([adb6b0e](https://github.com/ipfs/helia-unixfs/commit/adb6b0e2626a3bdd08cdc4445e3367f104bc5bb8))
73-
74-
75-
### Trivial Changes
76-
77-
* initial commit ([35e8a8f](https://github.com/ipfs/helia-unixfs/commit/35e8a8fd7c1ca68b21320b95211304bf01b30086))
78-
* Update .github/workflows/stale.yml [skip ci] ([bcb060d](https://github.com/ipfs/helia-unixfs/commit/bcb060d880175ab885479388049a1ca2e5873629))
79-
80-
81-
### Documentation
82-
83-
* update readme ([83e5e0e](https://github.com/ipfs/helia-unixfs/commit/83e5e0e0ccfd27f9371c9a8940c237e398e9b68f))

packages/strings/src/index.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ export interface Strings {
6363
* const cid = await str.add('hello world')
6464
*
6565
* console.info(cid)
66-
* // CID(QmFoo)
66+
* // CID(bafkreifzjut3te2nhyekklss27nh3k72ysco7y32koao5eei66wof36n5e)
6767
* ```
6868
*/
6969
add: (str: string, options?: Partial<AddOptions>) => Promise<CID>
@@ -79,7 +79,7 @@ export interface Strings {
7979
* import { CID } from 'multiformats/cid'
8080
*
8181
* const str = strings(helia)
82-
* const cid = CID.parse('')
82+
* const cid = CID.parse('bafkreifzjut3te2nhyekklss27nh3k72ysco7y32koao5eei66wof36n5e')
8383
* const string = await str.get(cid)
8484
*
8585
* console.info(string)

0 commit comments

Comments
 (0)