Skip to content

Commit 3bf22b2

Browse files
committed
chore: update readme
1 parent 0c964f1 commit 3bf22b2

File tree

1 file changed

+76
-0
lines changed

1 file changed

+76
-0
lines changed

README.md

+76
Original file line numberDiff line numberDiff line change
@@ -1 +1,77 @@
11
[![NodeJS CI](https://github.com/Conflux-Chain/helios/actions/workflows/nodejs.yaml/badge.svg?branch=dev)](https://github.com/Conflux-Chain/helios/actions/workflows/nodejs.yaml) [![codecov](https://codecov.io/gh/Conflux-Chain/helios/branch/dev/graph/badge.svg?token=Pv1R4q8svn)](https://codecov.io/gh/Conflux-Chain/helios)
2+
3+
# Fluent Browser Extension
4+
5+
Fluent supports Chrome, Firefox and Edge. You can install in:
6+
7+
- [Chrome](https://chromewebstore.google.com/detail/fluent/eokbbaidfgdndnljmffldfgjklpjkdoi)
8+
- [Firefox](https://addons.mozilla.org/en-US/firefox/addon/fluentwallet/)
9+
- [Edge](https://microsoftedge.microsoft.com/addons/detail/fluent/ldddehjcggepmlipdbempbnjehjehchh)
10+
11+
# Setup Environment
12+
13+
1. Install Node.js You can install Node.js from [here](https://nodejs.org/en/download). We use the current LTS version.
14+
15+
2. Install clojure
16+
17+
1. Install java
18+
19+
Macos
20+
21+
```bash
22+
brew install --cask temurin@21
23+
```
24+
25+
Ubuntu
26+
27+
```bash
28+
sudo apt install openjdk-21-jdk
29+
```
30+
31+
2. Install Clojure
32+
33+
Macos
34+
35+
```bash
36+
brew install clojure/tools/clojure
37+
```
38+
39+
Ubuntu, Ensure that the following dependencies are installed: bash, curl, rlwrap, and Java.
40+
41+
```bash
42+
curl -L -O https://github.com/clojure/brew-install/releases/latest/download/linux-install.sh
43+
chmod +x linux-install.sh
44+
sudo ./linux-install.sh
45+
```
46+
47+
About more install information you can find in here:https://clojure.org/guides/install_clojure#_linux_instructions
48+
49+
3. Run yarn install to install the dependencies
50+
51+
```bash
52+
yarn install
53+
```
54+
55+
# Development
56+
57+
Build the development version you can run:
58+
59+
- For Chrome: `yarn dev:chrome`
60+
61+
- For Firefox: `yarn dev:firefox`
62+
63+
- For Edge: `yarn dev:edge`
64+
65+
This will watch and build the extension in the `dist/firefox` , `dist/chrome` and `dist/edge` folder.
66+
67+
# Production
68+
69+
Build the production version you can run:
70+
71+
- For Chrome: `yarn build:chrome`
72+
73+
- For Firefox: `yarn build:firefox`
74+
75+
- For Edge: `yarn build:edge`
76+
77+
This will build the extension in the `dist/firefox` , `dist/chrome` and `dist/edge` folder.

0 commit comments

Comments
 (0)