aqua-ipfs/aqua/README.md
folex 25a493ab2e
CI: update aqua-ipfs version in Builtin Services (#22)
BREAKING CHANGE: IPFS builtin service id changed from 'ipfs-adapter' to 'aqua-ipfs'
2021-08-23 18:24:52 +03:00

16 lines
445 B
Markdown

# Aqua API of AquaIPFS
## Documentation
See [Aqua Book](https://fluence.dev/aqua-book/libraries/aqua-ipfs).
## API
Public API is defined in [ipfs-api.aqua](/aqua/ipfs-api.aqua).
aqua-ipfs service API is defined in [ipfs.aqua](/aqua/ipfs.aqua).
## How to use Aqua API in TypeScript
There's a simple example in [example](/example/index.ts)
## How to update ipfs.aqua from ipfs_pure.wasm
While in `aqua` directory, run `npm run generate-aqua`