fluencelabs/fluence-js
1
0
Fork 0
mirror of https://github.com/fluencelabs/fluence-js.git synced 2024-12-05 02:10:18 +00:00
Code Issues Projects Releases Wiki Activity

Fix docs (#12)

Browse Source
This commit is contained in:
Pavel 2021-01-29 16:57:41 +03:00 committed by GitHub
parent 92980379bd
commit 041b3acd8c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -17,7 +17,6 @@ Fluence is an open application platform where apps can build on each other, shar
<img alt="aquamarine scheme" align="center" src="doc/stack.png"/> <img alt="aquamarine scheme" align="center" src="doc/stack.png"/>
## Installation ## Installation
With npm With npm
@ -44,14 +43,13 @@ export const relayNode = dev[0];
Initialize client Initialize client
```typescript ```typescript
import { createClient, FluenceClient } from '@fluencelabs/fluence'; import { createClient, FluenceClient } from '@fluencelabs/fluence';
const client = await createClient(relayNode); const client = await createClient(relayNode);
``` ```
Add response service function calls Respond to service function calls
```typescript ```typescript
subscribeToEvent(client, 'helloService', 'helloFunction', (args) => { subscribeToEvent(client, 'helloService', 'helloFunction', (args) => {
@ -63,7 +61,8 @@ subscribeToEvent(client, 'helloService', 'helloFunction', (args) => {
Make a particle Make a particle
```typescript ```typescript
const particle = new Particle(` const particle = new Particle(
`
(seq (seq
(call myRelay ("op" "identify") [] result) (call myRelay ("op" "identify") [] result)
(call %init_peer_id% ("helloService" "helloFunction") [result]) (call %init_peer_id% ("helloService" "helloFunction") [result])
@ -84,7 +83,7 @@ Observe the result in browser console
```json ```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) 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: Sample applications:
* [FluentPad](https://github.com/fluencelabs/fluent-pad): a collaborative text editor with users online status synchronization - [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) - [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 ## Developing
@ -121,8 +120,8 @@ npm test
## Contributing ## 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 ## License
[Apache 2.0](LICENSE) [Apache 2.0](LICENSE)