From 041b3acd8c4f223fa3d41e16dbbf2d268622cc67 Mon Sep 17 00:00:00 2001 From: Pavel Date: Fri, 29 Jan 2021 16:57:41 +0300 Subject: [PATCH] Fix docs (#12) --- README.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index b797f5a57..112447adf 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,6 @@ Fluence is an open application platform where apps can build on each other, shar aquamarine scheme - ## Installation With npm @@ -44,14 +43,13 @@ export const relayNode = dev[0]; Initialize client - ```typescript import { createClient, FluenceClient } from '@fluencelabs/fluence'; const client = await createClient(relayNode); ``` -Add response service function calls +Respond to service function calls ```typescript subscribeToEvent(client, 'helloService', 'helloFunction', (args) => { @@ -63,7 +61,8 @@ subscribeToEvent(client, 'helloService', 'helloFunction', (args) => { Make a particle ```typescript -const particle = new Particle(` +const particle = new Particle( + ` (seq (call myRelay ("op" "identify") [] result) (call %init_peer_id% ("helloService" "helloFunction") [result]) @@ -84,7 +83,7 @@ Observe the result in browser console ```json { - "external_addresses": [ "/ip4/1.2.3.4/tcp/7777", "/dns4/dev.fluence.dev/tcp/19002" ] + "external_addresses": ["/ip4/1.2.3.4/tcp/7777", "/dns4/dev.fluence.dev/tcp/19002"] } ``` @@ -92,14 +91,14 @@ Observe the result in browser console SDK Reference: [readme.io](https://fluence-labs.readme.io/docs/js-sdk) -Detailed guide on building applications: [readme.io](https://fluence-labs.readme.io/docs/build-an-app) +Detailed guide on building applications: [readme.io](https://fluence-labs.readme.io/docs/build-an-app) Sample applications: -* [FluentPad](https://github.com/fluencelabs/fluent-pad): a collaborative text editor with users online status synchronization -* [Other demos](https://github.com/fluencelabs/aqua-demo): (Chat app, Social feed app, Blog platform app) +- [FluentPad](https://github.com/fluencelabs/fluent-pad): a collaborative text editor with users online status synchronization +- [Other demos](https://github.com/fluencelabs/aqua-demo): (Chat app, Social feed app, Blog platform app) -About [Fluence](https://fluence.network/) +About [Fluence](https://fluence.network/) ## Developing @@ -121,8 +120,8 @@ npm test ## Contributing -While the project is a still in the early stage of development, you are welcome to track progress and contribute. At the current moment we don't have detailed instructions on how to join development or which code guidelines to follow. However, you can expect more info to appear soon enough. In the meanwhile, check out the [basic contributing rules](CONTRIBUTING.md). +While the project is still in the early stages of development, you are welcome to track progress and contribute. As the project is undergoing rapid changes, interested contributors should contact the team before embarking on larger pieces of work. All contributors should consult with and agree to our [basic contributing rules](CONTRIBUTING.md). ## License -[Apache 2.0](LICENSE) \ No newline at end of file +[Apache 2.0](LICENSE)