Skip to content

docs: add usage example #97

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.

Sign up for GitHub

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

Merged
achingbrain merged 7 commits into from
May 3, 2023
Merged

docs: add usage example #97

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9177b25
add usage example
autonome Apr 18, 2023
00cdb99
docs: update examples
achingbrain May 3, 2023
e834805
docs: update examples
achingbrain May 3, 2023
541c20e
docs: update examples
achingbrain May 3, 2023
f7782a9
docs: update examples
achingbrain May 3, 2023
5472109
Merge branch 'main' into sane-defaults-example
achingbrain May 3, 2023
4c11b7e
Merge branch 'main' into sane-defaults-example
achingbrain May 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,18 @@
[![codecov](https://img.shields.io/codecov/c/github/ipfs/helia.svg?style=flat-square)](https://codecov.io/gh/ipfs/helia)
[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/helia/main.yml?branch=main\&style=flat-square)](https://github.com/ipfs/helia/actions/workflows/main.yml?query=branch%3Amain)

## Usage

```
import { createHelia } from 'helia';

const ipfs = await createHelia();

const myImmutableAddress = ipfs.add(JSON.stringify({ foo: "bar" }));

console.log(ipfs.get(myImmutableAddress));
```

## Table of contents <!-- omit in toc -->

- [🥅 Purpose and goals](#-purpose-and-goals)
Expand Down