From 264c09ef975b7828109e0a8becc4454cbf926eec Mon Sep 17 00:00:00 2001 From: bholuhacks Date: Sun, 25 Feb 2024 01:49:59 -0500 Subject: [PATCH] chore: use relative links --- README.md | 12 ++++++------ sdk/README.md | 6 +++--- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 6f69699f6..833cf3d11 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 Create Aleo App @@ -68,7 +68,7 @@ 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 @@ -76,11 +76,11 @@ Source: [`sdk/wasm`](https://github.com/AleoHQ/sdk/tree/testnet3/wasm) 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 diff --git a/sdk/README.md b/sdk/README.md index 32ad6707a..03bb841db 100644 --- a/sdk/README.md +++ b/sdk/README.md @@ -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: @@ -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 @@ -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