mirror of
https://github.com/fluencelabs/aqua-lib
synced 2024-12-04 15:20:23 +00:00
README: link to doc & add example
This commit is contained in:
parent
0842501dfe
commit
49f3b39e4a
25
readme.md
25
readme.md
@ -1,5 +1,4 @@
|
||||
## Aqua
|
||||
|
||||
Aqua is a new-gen language for distributed systems.
|
||||
|
||||
Aqua programs are executed on many peers, sequentially
|
||||
@ -10,12 +9,26 @@ Therefore, Aqua scripts are compiled into several targets at once, with AIR and
|
||||
|
||||
## aqua-lib
|
||||
|
||||
TBD
|
||||
API of the protocol-level functions in the Fluence Network.
|
||||
|
||||
### usage
|
||||
This API is available on all peers powered by Fluence nodes, and a part of the API is available on JS/TS-based (browsers, NodeJS) peers.
|
||||
|
||||
TBD
|
||||
### Documentation
|
||||
See [Aqua Book](https://fluence.dev/aqua-book/libraries/aqua-dht).
|
||||
|
||||
### references
|
||||
### How to use it in Aqua
|
||||
|
||||
Add `@fluencelabs/aqua-lib` to your package.json dependencies, and then in your Aqua script, import and use it:
|
||||
```haskell
|
||||
import "@fluencelabs/aqua-lib"
|
||||
|
||||
-- gather Peer.identify from all nodes in the neighbourhood
|
||||
func getPeersInfo() -> []Info:
|
||||
infos: *Info
|
||||
nodes <- Kademlia.neighborhood(%init_peer_id%, nil, nil)
|
||||
for node in nodes:
|
||||
on node:
|
||||
infos <- Peer.identify()
|
||||
<- infos
|
||||
```
|
||||
|
||||
- To get started writing aqua see: https://github.com/fluencelabs/aqua-playground
|
||||
|
Loading…
Reference in New Issue
Block a user