From e9453c3b717eae6bae4497aeb53723757a736a72 Mon Sep 17 00:00:00 2001 From: Nishant Arora <1895906+whizzzkid@users.noreply.github.com> Date: Thu, 6 Apr 2023 11:54:57 -0600 Subject: [PATCH] docs: create a list of examples (#27) Addresses: https://github.com/ipfs/helia/issues/35 In this PR: - summarizing examples in the readme, - companion PR: https://github.com/ipfs/helia/pull/76 --------- Co-authored-by: Alex Potsides --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index c51429b3..fc98bf5e 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,10 @@ - [Table of Contents](#table-of-contents) - [About The Project](#about-the-project) - [Getting Started](#getting-started) + - [Examples](#examples) + - [Basics](#basics) + - [Frameworks](#frameworks) + - [Bundlers](#bundlers) - [Prerequisites](#prerequisites) - [IPFS Tutorials at ProtoSchool](#ipfs-tutorials-at-protoschool) - [Documentation](#documentation) @@ -44,6 +48,28 @@ ## Getting Started +### Examples + +Feel free to jump directly into the examples, however going through the following sections will help build context and background knowledge. + +#### Basics + +- [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 `