From 1776619cee433d7e5c1a13f3d352ddacc0690750 Mon Sep 17 00:00:00 2001 From: folex <0xdxdy@gmail.com> Date: Tue, 30 Nov 2021 16:47:25 +0300 Subject: [PATCH] Update README.md --- README.md | 27 +++++++++++---------------- 1 file changed, 11 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index ad8fe47..9eebb05 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![npm](https://img.shields.io/npm/v/@fluencelabs/fluence-network-environment)](https://www.npmjs.com/package/@fluencelabs/fluence-network-environment) -Officially maintained list of well-known Fluence network nodes. The package is meant to be used in combination with [Fluence JS SDK](https://github.com/fluencelabs/fluence-js). +Maintained list of well-known Fluence network nodes. The package is meant to be used in combination with [Fluence JS SDK](https://github.com/fluencelabs/fluence-js). ## Installation @@ -23,32 +23,27 @@ yarn add @fluencelabs/fluence-network-environment Pick a node to connect to the Fluence network. ```typescript -import { dev } from '@fluencelabs/fluence-network-environment'; +import { testNet } from '@fluencelabs/fluence-network-environment'; -export const relayNode = dev[0]; +export const relayNode = testNet[0]; ``` Which can be used to initialize the Fluence client (see [Fluence JS SDK](https://github.com/fluencelabs/fluence-js).) ```typescript -import { createClient } from '@fluencelabs/fluence'; +import { FluencePeer } from '@fluencelabs/fluence'; -const client = await createClient(relayNode); +const peer = new FluencePeer; +await peer.start({ connectTo: relayNode }); ``` ## Known networks -### dev +- stage - unstable network for development tests; low capacity +- TestNet - more stable network, used for QA of new releases; higher capacity +- Krasnodar - stable network, has the highest load capacity -**Unstable** Several nodes running on the same physical host. Used a lot to test things out. - -### stage - -Environment primarily used for staging deployments of various Fluence services. - -### TestNet - -The main Fluence network. It consists of a ten nodes each running on a separate physical host. +All 3 networks are connected, i.e. any node can be discovered from every other. They're open and permissionless, meaning that anyone can use any node for bootstrapping. ## About Fluence @@ -68,4 +63,4 @@ Fluence is an open application platform where apps can build on each other, shar ## License -[Apache 2.0](https://github.com/fluencelabs/fluence/blob/trustless_computing/LICENSE.md) \ No newline at end of file +[Apache 2.0](https://github.com/fluencelabs/fluence/blob/trustless_computing/LICENSE.md)