From 1d7c511e1b1fbe971f2b79981d3f301a2864b6d4 Mon Sep 17 00:00:00 2001 From: NikolaiKryshnev <63440682+NikolaiKryshnev@users.noreply.github.com> Date: Tue, 28 Jan 2025 14:24:45 +0300 Subject: [PATCH 1/2] This PR improves the README with updated formatting, additional GitHub badges, and better-structured instructions. --- README.md | 124 +++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 85 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index 2812dc2..5bd2452 100644 --- a/README.md +++ b/README.md @@ -1,60 +1,106 @@ - +
+ +
-# Linera Web client +# 🌐 **Linera Web Client** -This repository implements a Web client for the Linera protocol. +This repository implements a **Web client** for the **Linera protocol**. -# Building +
-## Setup +[![GitHub Repo stars](https://img.shields.io/github/stars/linera-io/linera-web?logo=github&color=yellow)](https://github.com/linera-io/linera-web/stargazers) +[![GitHub forks](https://img.shields.io/github/forks/linera-io/linera-web?logo=github&color=blue)](https://github.com/linera-io/linera-web/network/members) +[![GitHub last commit](https://img.shields.io/github/last-commit/linera-io/linera-web?logo=git)](https://github.com/linera-io/linera-web/commits/main) +[![License](https://img.shields.io/badge/license-Apache-green.svg)](LICENSE)[![Website](https://img.shields.io/badge/Website-Linera.io-blue?style=flat&logo=google-chrome)](https://linera.io) +[![Telegram](https://img.shields.io/badge/Telegram-26A5E4?logo=telegram&logoColor=white)](https://t.me/linera_io) +[![Discord](https://img.shields.io/badge/Discord-5865F2?logo=discord&logoColor=white)](https://discord.gg/linera) +[![Twitter](https://img.shields.io/twitter/follow/linera_io?style=social)](https://x.com/linera_io) -This repository contains a Nix flake that precisely specifies its -build environment. The easiest way to set up the build environment is -to install Nix with flake support (e.g. using the [Determinate Nix -installer](https://github.com/DeterminateSystems/nix-installer)) and -then run `nix develop` to enter the build environment. -Currently we only support building on Linux (`x86_64-unknown-linux-gnu`). +
-## Building +--- -The project builds with `pnpm`. First install the JavaScript dependencies: +## ⚙️ **Setup** -```shellsession -pnpm install +This repository includes a **Nix flake** that precisely specifies its build environment. +To set up, install **Nix** with flake support (e.g., via the [Determinate Nix Installer](https://github.com/DeterminateSystems/nix-installer)) +and then run: + +📌 **Enter the build environment** + +```bash +nix develop ``` -Then build the extension: +Currently, **only Linux (`x86_64-unknown-linux-gnu`)** is supported. + +--- + +## 🏗 **Building the Project** -```shellsession -cd extension -pnpm build:extension +Linera Web Client builds with **pnpm**. + +**1️⃣ Install JavaScript dependencies:** + +```bash +pnpm install ``` -This will result in an unpacked Manifest v3 extension in -`extension/dist/extension`. +**2️⃣ Build the extension:** + +```bash +cd extension && pnpm build:extension + ``` -# Installation +This will generate an **unpacked Manifest v3 extension** in `extension/dist/extension`. -After successfully running `pnpm build`, the extension can be loaded -into Chrome or Chromium: +--- -- Open the settings menu. -- Select ‘Extensions’ → ‘Manage Extensions’. -- Enable ‘Developer mode’. This will show an option ‘Load unpacked’. -- Navigate to the `extension/dist` directory and select it. -- You've installed the extension! +## 🚀 **Installation** -By default extension icons are hidden behind a top-level ‘Extensions’ -menu in the browser toolbar; to make access easier, you can pin this -extension to have it appear at the top level next to the ‘Extensions’ -icon. +After successfully building the extension, you can load it into **Chrome/Chromium**: -# Development +1. Open the **settings menu**. +2. Navigate to **Extensions** → **Manage Extensions**. +3. Enable **Developer mode** (this will show an option **Load unpacked**). +4. Select the `extension/dist` directory. +5. ✅ **Done! The extension is installed!** -## Environment +To make access easier, **pin the extension** to appear in the top-level toolbar. + +--- + +## 🛠 **Development Mode** + +For development, use the **watch mode** to automatically rebuild on changes: + +```bash +pnpm build --watch +``` + +Changes to the **client worker** won’t be reflected until you manually run: + +```bash +wasm-pack build +``` -For development, you can also use `pnpm build --watch` to -automatically rebuild the extension on change. Changes to the client -worker will not propagate to the extension, but once you run -`wasm-pack build` they will be picked up. +--- + +## 💬 **Join the Community** + +

+ + Telegram + + + Discord + + + Twitter (X) + +

+ +🌐 **Official Website:** [Linera.io](https://linera.io) +📂 **Developer Docs:** [Linera.dev](https://linera.dev) +📖 **Whitepaper:** [Linera Whitepaper](https://linera.io/whitepaper) From 44c1b315d901129128afab82055b7d27671cb991 Mon Sep 17 00:00:00 2001 From: NikolaiKryshnev <63440682+NikolaiKryshnev@users.noreply.github.com> Date: Thu, 6 Feb 2025 23:38:41 +0300 Subject: [PATCH 2/2] Update README.md --- README.md | 33 ++++++++++++++++++++------------- 1 file changed, 20 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 5bd2452..cb4653d 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ -# 🌐 **Linera Web Client** +# **Linera Web Client** This repository implements a **Web client** for the **Linera protocol**. @@ -21,13 +21,13 @@ This repository implements a **Web client** for the **Linera protocol**. --- -## ⚙️ **Setup** +## **Setup** This repository includes a **Nix flake** that precisely specifies its build environment. To set up, install **Nix** with flake support (e.g., via the [Determinate Nix Installer](https://github.com/DeterminateSystems/nix-installer)) and then run: -📌 **Enter the build environment** +**Enter the build environment** ```bash nix develop @@ -37,17 +37,17 @@ Currently, **only Linux (`x86_64-unknown-linux-gnu`)** is supported. --- -## 🏗 **Building the Project** +## **Building the Project** Linera Web Client builds with **pnpm**. -**1️⃣ Install JavaScript dependencies:** +**1. Install JavaScript dependencies:** ```bash pnpm install ``` -**2️⃣ Build the extension:** +**2. Build the extension:** ```bash cd extension && pnpm build:extension @@ -57,7 +57,7 @@ This will generate an **unpacked Manifest v3 extension** in `extension/dist/exte --- -## 🚀 **Installation** +## **Installation** After successfully building the extension, you can load it into **Chrome/Chromium**: @@ -65,13 +65,13 @@ After successfully building the extension, you can load it into **Chrome/Chromiu 2. Navigate to **Extensions** → **Manage Extensions**. 3. Enable **Developer mode** (this will show an option **Load unpacked**). 4. Select the `extension/dist` directory. -5. ✅ **Done! The extension is installed!** +5. **Done! The extension is installed!** To make access easier, **pin the extension** to appear in the top-level toolbar. --- -## 🛠 **Development Mode** +## **Development Mode** For development, use the **watch mode** to automatically rebuild on changes: @@ -87,7 +87,7 @@ wasm-pack build --- -## 💬 **Join the Community** +## **Join the Community**

@@ -99,8 +99,15 @@ wasm-pack build Twitter (X) + + + Official Website + + + Developer Docs + + + Whitepaper +

-🌐 **Official Website:** [Linera.io](https://linera.io) -📂 **Developer Docs:** [Linera.dev](https://linera.dev) -📖 **Whitepaper:** [Linera Whitepaper](https://linera.io/whitepaper)