From 3fb36f5d66fe203f800d4ba7dad3642c6f5db31b Mon Sep 17 00:00:00 2001 From: sergeypanin1994 Date: Thu, 6 Feb 2025 14:28:25 +0300 Subject: [PATCH] Updated documentation for Blockless SDK AssemblyScript: improved grammar, formatting, and added clarifications for installation and usage examples --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 08a6317..1ca553e 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,27 @@ -# blockless-sdk-assembly-script +# Blockless SDK for AssemblyScript ![](blockless.png) -** This sdk is configured to work with `assembly-script`. ** +**This SDK is configured to work with `AssemblyScript`.** -## It currently has built in support for +## Built-in Support for - `cgi` - `http` - `ipfs` - `llm` -## Install this SDK +## Install This SDK -This module can be installed into any existing project. New projects should use `@blockless/app` to start a fresh `WASM` module. +This module can be installed into any existing project. For new projects, use `@blockless/app` to start a fresh `WASM` module. ```bash -npm i @blockless/sdk -# or using deno +npm install @blockless/sdk +# Or using Deno deno add @blockless/sdk ``` -## Example of using this SDK. +## Example Usage ```js // The entry file of your WebAssembly. @@ -36,9 +36,9 @@ const data = client.get("https://httpbin.org/json"); console.log(data.toString()) ``` -### How to build +### How to Build -Use `asc` to build the `typescript` source into a deployable `WASM` file. +Use `asc` to build the `TypeScript` source into a deployable `WASM` file. ```bash asc examples/index.ts --target release @@ -48,4 +48,4 @@ Shortcuts for a few examples are available in the `package.json` of this module. ```bash deno run build:example:debug -``` +``` \ No newline at end of file