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.

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

Jump to bottom

docs: create a list of examples #27

Merged
merged 6 commits into from
Apr 6, 2023
Merged

docs: create a list of examples #27

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
63a1560
fix(docs): :sparkles: Creating a list of examples.
whizzzkid Apr 4, 2023
a2c021e
Merge branch 'main' into fix/docs-pre-release-v1
achingbrain Apr 4, 2023
4672715
Merge branch 'main' into fix/docs-pre-release-v1
whizzzkid Apr 4, 2023
868a777
Update README.md
whizzzkid Apr 6, 2023
40a8a68
Update README.md
whizzzkid Apr 6, 2023
6224844
chore: whitespace
achingbrain Apr 6, 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 @@ -23,6 +23,7 @@
- [Table of Contents](#table-of-contents)
- [About The Project](#about-the-project)
- [Getting Started](#getting-started)
- [Examples](#examples)
whizzzkid marked this conversation as resolved.
Show resolved Hide resolved
- [Prerequisites](#prerequisites)
- [IPFS Tutorials at ProtoSchool](#ipfs-tutorials-at-protoschool)
- [Documentation](#documentation)
Expand All @@ -44,6 +45,17 @@

## Getting Started

### Examples

Feel free to jump directly in the examples, however it's highly recommended you go through the next sections before diving into helia example as that would help build context and background knowledge that maybe required.

- [Helia-101](/examples/helia-101/): Spawn a Helia node, add a file and cat the file.
- [Helia CommonJS](/examples/helia-cjs/): Just like Helia-101, but with [CommonJS](https://en.wikipedia.org/wiki/CommonJS) instead of [ESM](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules)
- [Helia via CDNs](/examples/helia-script-tag/): A simple proof-of-concept to distributing and using helia using `<script>` tags.
- [Helia with React+Vite](/examples/helia-vite-react/): Create a react+vite app with helia.
- [Helia + Webpack](/examples/helia-webpack/): Bundle helia with webpack.


whizzzkid marked this conversation as resolved.
Show resolved Hide resolved
### Prerequisites

Make sure you have installed all of the following prerequisites on your development machine:
Expand Down