Skip to content
This repository has been archived by the owner on Dec 12, 2024. It is now read-only.

Commit

Permalink
update some READMEs with the new repo
Browse files Browse the repository at this point in the history
  • Loading branch information
finn-block committed Jun 13, 2024
1 parent 1ca83b6 commit b0bf3a9
Show file tree
Hide file tree
Showing 8 changed files with 32 additions and 16 deletions.
4 changes: 2 additions & 2 deletions javascript/book-reviews/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

Build a book review app using Web5.

*Tutorial:* https://developer.tbd.website/docs/web5/build/apps/book-reviews-tutorial
*Tutorial:* <https://developer.tbd.website/docs/web5/build/apps/book-reviews-tutorial>

See it in action 👇

[![Edit in CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/TBD54566975/developer.tbd.website/tree/main/examples/tutorials/book-reviews)
[![Edit in CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/TBD54566975/tbd-examples/tree/main/javascript/book-reviews)
8 changes: 6 additions & 2 deletions javascript/dinger-starter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,19 @@

This is the starter code for Dinger, a self-sovereign, modern day pager that allows users to send short text-based messages or "dings" to each other. It is a demo application that demonstrates peer-to-peer communication in the Web5 ecosystem.

[![Edit in CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/TBD54566975/developer.tbd.website/tree/main/examples/tutorials/dinger-starter)
[![Edit in CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/TBD54566975/tbd-examples/tree/main/javascript/dinger-starter)

Technologies:

- Next.js
- CSS
- React
- Web5.js

## Complete the project
Learn how to complete the project by following this tutorial [tutorial](https://developer.tbd.website/docs/web5/build/apps/dinger-tutorial) and reviewing the [completed code](https://codesandbox.io/p/sandbox/github/TBD54566975/developer.tbd.website/tree/main/examples/tutorials/dinger-completed).

Learn how to complete the project by following this tutorial [tutorial](https://developer.tbd.website/docs/web5/build/apps/dinger-tutorial) and reviewing the [completed code](https://codesandbox.io/p/sandbox/github/TBD54566975/tbd-examples/tree/main/javascript/dinger-completed).

## Setup

Install dependencies:
Expand Down
6 changes: 4 additions & 2 deletions javascript/dinger/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@

This is a self-sovereign, modern day pager that allows users to send short text-based messages or "dings" to each other. It is a demo application that demonstrates peer-to-peer communication in the Web5 ecosystem.

[![Edit in CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/TBD54566975/developer.tbd.website/tree/main/examples/tutorials/dinger-completed)
[![Edit in CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/TBD54566975/tbd-examples/tree/main/javascript/dinger-completed)

Technologies:

- Next.js
- CSS
- React
Expand Down Expand Up @@ -41,4 +42,5 @@ yarn dev
```

## Want to learn how to build this on your own?
Check out the [tutorial](https://developer.tbd.website/docs/web5/build/apps/dinger-tutorial) and [starter code](https://codesandbox.io/p/sandbox/github/TBD54566975/developer.tbd.website/tree/main/examples/tutorials/dinger-starter).

Check out the [tutorial](https://developer.tbd.website/docs/web5/build/apps/dinger-tutorial) and [starter code](https://codesandbox.io/p/sandbox/github/TBD54566975/tbd-examples/tree/main/javascript/dinger-starter).
11 changes: 8 additions & 3 deletions javascript/fan-club-credential/README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,31 @@
# Fan Club Credential Example

## Overview

This example demonstrates how to use the @web5/credentials package to issue and verify Verifiable Credentials (VCs). It includes creating issuer and subject DIDs, issuing a signed VC, and then verifying it. Also it will show how to issue a self signed VC and store it in your DWN.

## Prerequisites

* Node.js v18.16.1 or later
* npm (Node Package Manager)

## Installation

Clone the tutorial repository and navigate to the `fan-club-credential` directory:

```bash
git clone https://github.com/TBD54566975/developer.tbd.website.git
cd developer.tbd.website/examples/tutorials/fan-club-credential
git clone https://github.com/TBD54566975/tbd-examples.git
cd tbd-examples/javascript/fan-club-credential
```

Install the required npm packages:

```bash
npm install
```

## Usage

The index.js file contains the main logic for the example. It performs the following steps:

* Creates issuer and subject DIDs.
Expand All @@ -34,4 +40,3 @@ Run the script using Node.js:
```bash
node index.js
```

4 changes: 3 additions & 1 deletion javascript/shared-todo-starter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,16 @@

This is the UI scaffolding of a simple Web5 app to manage a set of todos towards your goals with friends.

[![Edit in CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/TBD54566975/developer.tbd.website/tree/main/examples/tutorials/shared-todo-starter)
[![Edit in CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/TBD54566975/tbd-examples/tree/main/javascript/shared-todo-starter)

Currently set up with:

- Nuxt 3
- TailWind CSS (including Typography and forms)
- SASS

To be added:

- Web5 - Decentralized Identifiers, Web Nodes, Protocols etc.

## Setup
Expand Down
4 changes: 3 additions & 1 deletion javascript/shared-todo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,16 @@

This is the completed project of a simple Web5 app to manage a set of todos towards your goals with friends.

[![Edit in CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/TBD54566975/developer.tbd.website/tree/main/examples/tutorials/shared-todo-completed)
[![Edit in CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/TBD54566975/tbd-examples/tree/main/javascript/shared-todo-completed)

Currently set up with:

- Nuxt 3
- TailWind CSS (including Typography and forms)
- SASS

To be added:

- Web5 - Decentralized Identifiers, Web Nodes, Protocols etc.

## Setup
Expand Down
4 changes: 2 additions & 2 deletions javascript/todo-starter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

This is a tutorial for using web5.js to creat a todo app.

To view the completed version of this tutorial, check out [this repository](https://github.com/TBD54566975/developer.tbd.website/tree/main/examples/tutorials/todo-completed).
To view the completed version of this tutorial, check out [this repository](https://github.com/TBD54566975/tbd-examples/tree/main/javascript/todo-completed).

All change you'll make will be in /src/App.vue.

[![Edit in CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/TBD54566975/developer.tbd.website/tree/main/examples/tutorials/todo-starter)
[![Edit in CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/TBD54566975/tbd-examples/tree/main/javascript/todo-starter)
7 changes: 4 additions & 3 deletions javascript/todo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@

The main code that powers this app is [here](./src/App.vue)

This Todo app uses the Web5 JS SDK (https://www.npmjs.com/package/@web5/api) to create a DWN in your browser and add todos
This Todo app uses the [Web5 JS SDK](https://www.npmjs.com/package/@web5/api) to create a DWN in your browser and add todos

[![Edit in CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/TBD54566975/developer.tbd.website/tree/main/examples/tutorials/todo-completed)
[![Edit in CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/TBD54566975/tbd-examples/tree/main/javascript/todo-completed)

## Run and Build

## Run and Build:
Step 1: `npm install && npm run dev`

Step 2: Navigate to `http://localhost:5173` <br />
Expand Down

0 comments on commit b0bf3a9

Please sign in to comment.