Skip to content

Commit 0d71ab2

Browse files
authored
Merge branch 'main' into 561-CaDB
2 parents 3ecaab2 + 99a847b commit 0d71ab2

File tree

3 files changed

+480
-13
lines changed

3 files changed

+480
-13
lines changed

README.md

Lines changed: 29 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,36 +19,52 @@ Visit [SUPPORTED_FEATURES.md](SUPPORTED_FEATURES.md) to see the full list of fea
1919

2020
[>>> Watch the demo <<<](https://www.youtube.com/watch?v=5yn3_g6Cybw)
2121

22+
## Quick start
23+
24+
```bash
25+
curl fablo.io/install.sh | bash
26+
./fablo init node rest
27+
./fablo up
28+
```
29+
30+
This will create a local Hyperledger Fabric network with a sample Node.js chaincode (using the `node` parameter) and a REST API client (using the `rest` parameter).
31+
After a few minutes, the entire network will be set up and running.
32+
33+
You can check the running nodes using `docker ps` or `docker stats`. You can also query the network via the command line (`fablo chaincode invoke` or `fablo chaincode query`), use the REST API client (see [Fablo REST](https://github.com/fablo-io/fablo-rest)), or view the network topology in the `fablo-target/network-topology.mmd` Mermaid diagram.
34+
2235
## Installation
2336

2437
Fablo is distributed as a single shell script that uses a Docker image to generate the network configuration.
25-
You can keep the script in the root directory of your project or install it globally on your system.
26-
27-
To get a copy of Fablo for a single project, run this command in your project root:
38+
To install it locally in your project directory:
2839

2940
```bash
30-
curl -Lf https://github.com/hyperledger-labs/fablo/releases/download/2.4.3/fablo.sh -o ./fablo && chmod +x ./fablo
41+
curl fablo.io/install.sh | bash
42+
# OR
43+
curl fablo.io/fablo.sh > fablo && chmod +x fablo
3144
```
3245

33-
To install it globally, run:
46+
To install it globally on your system:
3447

3548
```bash
36-
sudo curl -Lf https://github.com/hyperledger-labs/fablo/releases/download/2.4.3/fablo.sh -o /usr/local/bin/fablo && sudo chmod +x /usr/local/bin/fablo
49+
sudo curl fablo.io/fablo.sh -o /usr/local/bin/fablo && sudo chmod +x /usr/local/bin/fablo
3750
```
3851

39-
## Getting started
52+
To install a given version use:
53+
54+
```bash
55+
curl https://github.com/hyperledger-labs/fablo/releases/download/<version>/fablo.sh
56+
```
4057

41-
To create a local Hyperledger Fabric network with Node.js chaincode and REST API client, install Fablo and run:
58+
To change version of current installation:
4259

4360
```bash
44-
fablo init node rest
45-
fablo up
61+
fablo use <version>
4662
```
4763

48-
Note: For local setup use `./fablo` instead of `fablo`.
64+
Note: If you install Fablo as a local script, you call it as `./fablo <command>`.
65+
If you install it globally, you call `fablo <command>`.
66+
For the simplicity we will refer to it as `fablo`.
4967

50-
After a few minutes, the entire network will be set up and running.
51-
You can check the running nodes using `docker ps` or `docker stats`, and query the network via command line (`fablo chaincode invoke|query`) or REST API client (via [Fablo REST](https://github.com/fablo-io/fablo-rest)).
5268

5369
## Basic usage
5470

0 commit comments

Comments
 (0)