Skip to content

Commit 041b3ac

Browse files
authored
Fix docs (#12)
1 parent 9298037 commit 041b3ac

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ Fluence is an open application platform where apps can build on each other, shar
1717

1818
<img alt="aquamarine scheme" align="center" src="doc/stack.png"/>
1919

20-
2120
## Installation
2221

2322
With npm
@@ -44,14 +43,13 @@ export const relayNode = dev[0];
4443

4544
Initialize client
4645

47-
4846
```typescript
4947
import { createClient, FluenceClient } from '@fluencelabs/fluence';
5048

5149
const client = await createClient(relayNode);
5250
```
5351

54-
Add response service function calls
52+
Respond to service function calls
5553

5654
```typescript
5755
subscribeToEvent(client, 'helloService', 'helloFunction', (args) => {
@@ -63,7 +61,8 @@ subscribeToEvent(client, 'helloService', 'helloFunction', (args) => {
6361
Make a particle
6462

6563
```typescript
66-
const particle = new Particle(`
64+
const particle = new Particle(
65+
`
6766
(seq
6867
(call myRelay ("op" "identify") [] result)
6968
(call %init_peer_id% ("helloService" "helloFunction") [result])
@@ -84,22 +83,22 @@ Observe the result in browser console
8483

8584
```json
8685
{
87-
"external_addresses": [ "/ip4/1.2.3.4/tcp/7777", "/dns4/dev.fluence.dev/tcp/19002" ]
86+
"external_addresses": ["/ip4/1.2.3.4/tcp/7777", "/dns4/dev.fluence.dev/tcp/19002"]
8887
}
8988
```
9089

9190
## Documentation
9291

9392
SDK Reference: [readme.io](https://fluence-labs.readme.io/docs/js-sdk)
9493

95-
Detailed guide on building applications: [readme.io](https://fluence-labs.readme.io/docs/build-an-app)
94+
Detailed guide on building applications: [readme.io](https://fluence-labs.readme.io/docs/build-an-app)
9695

9796
Sample applications:
9897

99-
* [FluentPad](https://github.com/fluencelabs/fluent-pad): a collaborative text editor with users online status synchronization
100-
* [Other demos](https://github.com/fluencelabs/aqua-demo): (Chat app, Social feed app, Blog platform app)
98+
- [FluentPad](https://github.com/fluencelabs/fluent-pad): a collaborative text editor with users online status synchronization
99+
- [Other demos](https://github.com/fluencelabs/aqua-demo): (Chat app, Social feed app, Blog platform app)
101100

102-
About [Fluence](https://fluence.network/)
101+
About [Fluence](https://fluence.network/)
103102

104103
## Developing
105104

@@ -121,8 +120,8 @@ npm test
121120

122121
## Contributing
123122

124-
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).
123+
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).
125124

126125
## License
127126

128-
[Apache 2.0](LICENSE)
127+
[Apache 2.0](LICENSE)

0 commit comments

Comments
 (0)