aqua-ipfs/README.md

# Aqua IPFS bindings
Native IPFS integration to Aqua language. Orchestrate IPFS file transfer with Aqua scripts.

## Documentation
See [Aqua Book](https://fluence.dev/aqua-book/libraries/aqua-ipfs).

## How to use it in TypeScript
There's a simple example in [example](/example/index.ts)

## Directory structure
- `aqua` Aqua API of AquaIPFS. See [aqua/README](/aqua/README.md)
- `service` contains Rust service that implements all the IPFS calls by using `ipfs` cli mounted binary
- `example` A simple example of how to use ipfs adapter from TypeScript
- `local-network` contains Docker Compose YAML config to run a local Fluence network of 3 nodes

# Contribution
Contributions are welcome!

`aqua-ipfs` integrates with IPFS by using `ipfs` CLI, so it's possible to expose virtually any IPFS API to Aqua. Feel free to open an issue or contribute APIs and patterns you find useful.
CI: publish to NPM + auto changelog + separate example (#16) 2021-07-23 16:26:45 +03:00			`# Aqua IPFS bindings`
			`Native IPFS integration to Aqua language. Orchestrate IPFS file transfer with Aqua scripts.`

README: add link to doc 2021-07-30 14:42:43 +03:00			`## Documentation`
			`See [Aqua Book](https://fluence.dev/aqua-book/libraries/aqua-ipfs).`

CI: publish to NPM + auto changelog + separate example (#16) 2021-07-23 16:26:45 +03:00			`## How to use it in TypeScript`
README: fix TypeScript instructions 2022-03-31 02:49:54 +04:00			`There's a simple example in [example](/example/index.ts)`
CI: publish to NPM + auto changelog + separate example (#16) 2021-07-23 16:26:45 +03:00
README + Aqua API doc (#15) 2021-07-21 20:19:13 +03:00			`## Directory structure`
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			- `aqua` Aqua API of AquaIPFS. See [aqua/README](/aqua/README.md)
README + Aqua API doc (#15) 2021-07-21 20:19:13 +03:00			- `service` contains Rust service that implements all the IPFS calls by using `ipfs` cli mounted binary
CI: publish to NPM + auto changelog + separate example (#16) 2021-07-23 16:26:45 +03:00			- `example` A simple example of how to use ipfs adapter from TypeScript
README + Aqua API doc (#15) 2021-07-21 20:19:13 +03:00			- `local-network` contains Docker Compose YAML config to run a local Fluence network of 3 nodes
CI: publish to NPM + auto changelog + separate example (#16) 2021-07-23 16:26:45 +03:00
			`# Contribution`
			`Contributions are welcome!`

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			`aqua-ipfs` integrates with IPFS by using `ipfs` CLI, so it's possible to expose virtually any IPFS API to Aqua. Feel free to open an issue or contribute APIs and patterns you find useful.