Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: ✨ Mapping unixFS and IPNS packages #76

Merged
merged 3 commits into from
Apr 4, 2023
Merged

Conversation

whizzzkid
Copy link
Contributor

@whizzzkid whizzzkid commented Apr 4, 2023

Addresses: #35

In this PR:

Comment on lines +41 to +42
- [`@helia/UnixFS`](https://github.com/ipfs/helia-unixfs)
- [`@helia/ipns`](https://github.com/ipfs/helia-ipns)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

README.md Outdated
@@ -31,9 +32,20 @@ A lean, modular, and modern implementation of IPFS for the prolific JS and brows

See the [Manifesto](./MANIFESTO.md) and the [State of IPFS in JS blog post from October 2022](https://blog.ipfs.tech/state-of-ipfs-in-js/) for more info.

## Getting Started

Helia ships with an [examples repo](https://github.com/ipfs-examples/helia-examples#examples), which covers a wide variety of use cases. If you feel something has been missed, follow the [contribution guide](https://github.com/ipfs-examples/helia-examples#contributing) and create a PR to the examples repo.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@whizzzkid whizzzkid requested a review from SgtPooki April 4, 2023 07:34
@whizzzkid whizzzkid marked this pull request as ready for review April 4, 2023 07:34
@achingbrain achingbrain changed the title fix(docs): ✨ Mapping unixFS and IPNS packages docs: ✨ Mapping unixFS and IPNS packages Apr 4, 2023
Copy link
Member

@SgtPooki SgtPooki left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

README.md Outdated Show resolved Hide resolved
Co-authored-by: Alex Potsides <alex@achingbrain.net>
@whizzzkid whizzzkid merged commit aed72c2 into main Apr 4, 2023
@whizzzkid whizzzkid deleted the fix/docs-pre-v1 branch April 4, 2023 18:58
achingbrain added a commit to ipfs-examples/helia-examples that referenced this pull request Apr 6, 2023
Addresses: ipfs/helia#35

In this PR:

- summarizing examples in the readme,
- companion PR: ipfs/helia#76

---------

Co-authored-by: Alex Potsides <alex@achingbrain.net>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants