fluencelabs/fluence-js
1
0
Fork 0
mirror of https://github.com/fluencelabs/fluence-js.git synced 2024-12-04 09:50:17 +00:00
Code Issues Projects Releases Wiki Activity

Fix typedoc.md

Browse Source
This commit is contained in:
Pavel Murygin 2023-02-20 20:47:58 +04:00
parent 684fd2b789
commit 64dec2a8d1
1 changed files with 2 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
packages/client/api/typedoc.md
View File

@ -1,16 +1,3 @@
# Fluence JS
# Fluence JS Client
To start developing applications with Fluence JS refer to the official [documentation](https://fluence.dev/docs/build/fluence-js/)
Fluence JS is an implementation of the Fluence protocol for JavaScript-based environments. It can connect browsers, Node.js applications, and so on to the Fluence p2p network.
Similar to the [Rust Fluence Peer implementation](https://github.com/fluencelabs/fluence) it includes:
- Peer-to-peer communication layer (via [js-libp2p](https://github.com/libp2p/js-libp2p))
- [Aqua VM](https://github.com/fluencelabs/aquavm)
- Builtin services
Fluence JS can call services and functions on the Fluence network, and expose new APIs to the p2p network directly from TypeScript and JavaScript.
[Aqua language](https://github.com/fluencelabs/aqua) uses Fluence JS as a compilation target, and they are designed to [work in tandem](https://fluence.dev/docs/build/fluence-js/in-depth#understanding-the-aqua-compiler-output).
Fluence JS can be used with any framework of your choice \(or even without frameworks\).
This is the Javascript client for the [Fluence](https://fluence.network) network. The main role of the JS client is to connect to Fluence Network and allow you to integrate Aqua code into your application.