diff --git a/js-sdk/1_concepts.md b/js-sdk/1_concepts.md index c303257..b04b604 100644 --- a/js-sdk/1_concepts.md +++ b/js-sdk/1_concepts.md @@ -34,7 +34,7 @@ The main entry point `@fluencelabs/fluence` is `Fluence` facade. It provides eas Even though the js-based implementation closely resembles [node](https://github.com/fluencelabs/gitbook-docs/js-sdk/node.md) there are some considerable differences to the latter. -`FluencePeer` does not host services composed of wasm modules. Instead it allows to register service call handlers directly in javascript. The Aqua language compiler creates a typed helpers for that task. Using Aqua compiler is strongly advised when working with JS SDK. +`FluencePeer` does not host services composed of wasm modules. Instead it allows to register service call handlers directly in javascript. The Aqua language compiler creates a typed helpers for that task. Due to the limitations of browser-based environment `FluencePeer` cannot be discovered by it's Peer Id on it's own. To overcome this `FluencePeer` must use an existing node which will act as a `relay`. When a peer is connected through a relay it is considered to be `client`. The `FluencePeer` routes all it's particle through it's relay thus taking advantage of the peer discovery implemented on the node. A particle sent to the connected client must be routed through it's relay. diff --git a/js-sdk/2_basics.md b/js-sdk/2_basics.md index e7f99ab..37b5abb 100644 --- a/js-sdk/2_basics.md +++ b/js-sdk/2_basics.md @@ -2,7 +2,7 @@ ## Intro -In this section we will show you how JS SDK can be used to create a hello world application with Fluence stack. +In this section we will show you how Fluence JS can be used to create a hello world application with Fluence stack. ## Aqua code @@ -167,6 +167,6 @@ node -r ts-node/register src/index.ts If everything has been done correctly yuo should see `Hello, world!` in the console. -The next section will cover in-depth and advanced usage JS SDK +The next section will cover in-depth and advanced usage of Fluence JS The code from this section is available in on [github](https://github.com/fluencelabs/examples/tree/main/js-sdk-examples/hello-world) diff --git a/js-sdk/3_in_depth.md b/js-sdk/3_in_depth.md index 5d65467..1ce9e41 100644 --- a/js-sdk/3_in_depth.md +++ b/js-sdk/3_in_depth.md @@ -2,7 +2,7 @@ ## Intro -In this section we will cover the JS SDK in-depth. +In this section we will cover the Fluence JS in-depth. ## Fluence diff --git a/js-sdk/4_run_in_browser-1.md b/js-sdk/4_run_in_browser-1.md index c908f83..60376f3 100644 --- a/js-sdk/4_run_in_browser-1.md +++ b/js-sdk/4_run_in_browser-1.md @@ -1,6 +1,6 @@ # Running app in browser -You can use the JS SDK with any framework \(or even without it\). The "fluence" part of the application is a collection of pure typescript\javascript functions which can be called withing any framework of your choosing. +You can use the Fluence JS with any framework \(or even without it\). The "fluence" part of the application is a collection of pure typescript\javascript functions which can be called withing any framework of your choosing. See the browser-example which demonstrate integrating Fluence with React: [github](https://github.com/fluencelabs/examples/tree/main/js-sdk-examples/browser-example) diff --git a/js-sdk/5_run_in_node.md b/js-sdk/5_run_in_node.md index f30a957..2816733 100644 --- a/js-sdk/5_run_in_node.md +++ b/js-sdk/5_run_in_node.md @@ -2,7 +2,7 @@ ## Intro -JS SDK makes it easy to run applications in NodeJS environment. You can take full advantage of the javascript ecosystem and at the save time expose service to the Fluence Network. That makes is an excellent choice for quick prototyping of applications for Fluence Stack. +It is easy to use Fluence JS in NodeJS applications. You can take full advantage of the javascript ecosystem and at the save time expose service to the Fluence Network. That makes is an excellent choice for quick prototyping of applications for Fluence Stack. ## Calc app example diff --git a/knowledge_knowledge/knowledge_tools.md b/knowledge_knowledge/knowledge_tools.md index b736f7c..78c3624 100644 --- a/knowledge_knowledge/knowledge_tools.md +++ b/knowledge_knowledge/knowledge_tools.md @@ -72,7 +72,7 @@ Options: [number] [required] [default: 60000] ``` -## Fluence JS SDK +## Fluence JS -The Fluence [JS SDK](https://github.com/fluencelabs/fluence-js) supports developers to build full-fledged applications for a variety of targets ranging from browsers to backend apps and greatly expands on the `fldist` capabilities. +The [Fluence JS](https://github.com/fluencelabs/fluence-js) supports developers to build full-fledged applications for a variety of targets ranging from browsers to backend apps and greatly expands on the `fldist` capabilities. diff --git a/knowledge_node_services.md b/knowledge_node_services.md index c9d2b55..4f8d31d 100644 --- a/knowledge_node_services.md +++ b/knowledge_node_services.md @@ -9,10 +9,10 @@ Each Fluence peer is equipped with a set of "built-in" services that can be call 3. _srv_ – management and information about services on a node 4. _dist_ – distribution and inspection of modules and blueprints 5. _script_ – to manage recurring scripts -6. _op_ – basic operations on data deprecated - namespace for deprecated API Below is the reference documentation for all the existing built-in services. Please refer to the JS SDK documentation to learn how to easily use them from the JS SDK +6. _op_ – basic operations on data deprecated - namespace for deprecated API Below is the reference documentation for all the existing built-in services. Please refer to the Fluence JS documentation to learn how to easily use them from the Fluence JS 7. _deprecated_ - namespace for deprecated API -Please note that the [`fldist`](knowledge_tools.md#fluence-proto-distributor-fldist) CLI tool, as well as the [JS SDK](knowledge_tools.md#fluence-js-sdk), provide access to node-based services. +Please note that the [`fldist`](knowledge_tools.md#fluence-proto-distributor-fldist) CLI tool, as well as the [Fluence JS](knowledge_tools.md#fluence-js-sdk), provide access to node-based services. ## API diff --git a/knowledge_tools.md b/knowledge_tools.md index 174d3c1..069bf7d 100644 --- a/knowledge_tools.md +++ b/knowledge_tools.md @@ -39,9 +39,9 @@ Options: [number] [required] [default: 60000] ``` -### Fluence JS SDK +### Fluence JS -The Fluence [JS SDK](https://github.com/fluencelabs/fluence-js) supports developers to build full-fledged applications for a variety of targets ranging from browsers to backend apps and greatly expands on the `fldist` capabilities. +The [Fluence JS](https://github.com/fluencelabs/fluence-js) supports developers to build full-fledged applications for a variety of targets ranging from browsers to backend apps and greatly expands on the `fldist` capabilities. ### Marine Tools diff --git a/node/knowledge_node_services.md b/node/knowledge_node_services.md index c682abd..14a2a6f 100644 --- a/node/knowledge_node_services.md +++ b/node/knowledge_node_services.md @@ -9,10 +9,10 @@ Each Fluence node is equipped with a set of "builtin" services that can be calle 3. _srv_ – management and information about services on a node 4. _dist_ – distribution and inspection of modules and blueprints 5. _script_ – to manage recurring scripts -6. _op_ – basic operations on data deprecated - namespace for deprecated API Below is the reference documentation for all the existing built-in services. Please refer to the JS SDK documentation to learn how to easily use them from the JS SDK +6. _op_ – basic operations on data deprecated - namespace for deprecated API Below is the reference documentation for all the existing built-in services. Please refer to the Fluence JS documentation to learn how to easily use them from the Fluence JS 7. _deprecated_ - namespace for deprecated API -Please note that the [`fldist`](../knowledge_tools.md#fluence-proto-distributor-fldist) CLI tool, as well as the [JS SDK](../knowledge_tools.md#fluence-js-sdk), provide access to node-based services. +Please note that the [`fldist`](../knowledge_tools.md#fluence-proto-distributor-fldist) CLI tool, as well as the [Fluence JS](../knowledge_tools.md#fluence-js-sdk), provide access to node-based services. ## API