Skip to content

Commit

Permalink
chore: use relative links
Browse files Browse the repository at this point in the history
  • Loading branch information
enjoyooor committed Feb 25, 2024
1 parent a08416f commit 264c09e
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ The official Aleo SDK providing Javascript/Typescript tools for creating zero kn

### ⚡ Build your own app

Start here with the [Aleo SDK Readme](https://github.com/AleoHQ/sdk/tree/testnet3/sdk#readme) to get started building your
Start here with the [Aleo SDK Readme](/testnet3/sdk#readme) to get started building your
first zero knowledge web app.

#### Source: [`sdk/sdk`](https://github.com/AleoHQ/sdk/tree/testnet3/sdk)
#### Source: [`sdk/sdk`](/testnet3/sdk)


## 2. Create-Aleo-App - Zero Knowledge Web App Examples
Expand All @@ -50,7 +50,7 @@ You can start with a template by running
npm create aleo-app@latest
```

#### Source: [`sdk/create-aleo-app`](https://github.com/AleoHQ/sdk/tree/testnet3/create-aleo-app)
#### Source: [`sdk/create-aleo-app`](/testnet3/create-aleo-app)

## 3. Aleo-Wasm - Zero Knowledge Algorithms in JavaScript + WebAssembly
<a href="https://www.npmjs.com/package/@aleohq/wasm"> <img alt="Create Aleo App" src="https://img.shields.io/npm/l/%40aleohq%2Fwasm?label=NPM%20-%20Aleo%20Wasm&labelColor=green&color=blue"></a>
Expand All @@ -68,19 +68,19 @@ source.
❗ Currently program execution is only available in web Browsers. However account, program and data management within
NodeJS is functional.

Source: [`sdk/wasm`](https://github.com/AleoHQ/sdk/tree/testnet3/wasm)
Source: [`sdk/wasm`](/testnet3/wasm)

## 📚 Documentation

#### [API Documentation](https://developer.aleo.org/sdk/typescript/overview)
API Documentation, tutorials for the Aleo SDK, and documentation on how to build Leo and Aleo Instructions programs can
be found on the [Aleo Developer Docs](https://developer.aleo.org/sdk/typescript/overview) page.

#### [SDK Readme](https://github.com/AleoHQ/sdk/tree/testnet3/sdk#readme)
#### [SDK Readme](/testnet3/sdk#readme)
The SDK Readme provides concepts core to executing zero knowledge programs in the web and several detailed examples of
how to use the SDK to build web apps using Aleo.

#### [Aleo Wasm Readme](https://github.com/AleoHQ/sdk/tree/testnet3/wasm#readme)
#### [Aleo Wasm Readme](/testnet3/wasm#readme)
The Aleo Wasm Readme provides instructions for compiling the Aleo Wasm crate and using it in web projects. Those who
want to build from source or create their own WebAssembly bindings should start here

Expand Down
6 changes: 3 additions & 3 deletions sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ To build the project from source, go to this project's root and execute:

### Create Aleo App
A set of fully functional examples of zero knowledge web apps can be found in
[create-aleo-app](https://github.com/AleoHQ/sdk/tree/testnet3/create-aleo-app). Create-aleo-app provides several web-app
[create-aleo-app](/testnet3/create-aleo-app). Create-aleo-app provides several web-app
templates in common web frameworks such as React that can be used as a starting point for building zero knowledge web apps.

Developers can get started immediately with create-react-app by running:
Expand All @@ -84,7 +84,7 @@ Developers can get started immediately with create-react-app by running:

Additionally, the SDK powers [aleo.tools](https://aleo.tools) - a React app that provides a graphical interface for most
of the functionality provided by the SDK and can be used as a reference for usage of the SDK. Source code for aleo.tools
can be found [in the SDK repo here](https://github.com/AleoHQ/sdk/tree/testnet3/website)
can be found [in the SDK repo here](/testnet3/website)

## Usage

Expand Down Expand Up @@ -168,7 +168,7 @@ The SDK provides the ability execute `Aleo Instructions` programs %100 client-si
The `ProgramManager` object encapsulates the functionality for executing programs and making zero knowledge proofs about
them. Under the hood it uses cryptographic code compiled from [SnarkVM](https://developer.aleo.org/aleo) into WebAssembly
with JavaScript bindings that allow execution of Aleo programs fully within the browser. Users interested in lower level
details how this is achieved can visit the [aleo-wasm](https://github.com/AleoHQ/sdk/tree/testnet3/wasm) crate.
details how this is achieved can visit the [aleo-wasm](/testnet3/wasm) crate.

The basic execution flow of a program is as follows:
1. A web app is loaded with an instance of the `ProgramManager` object
Expand Down

0 comments on commit 264c09e

Please sign in to comment.