From fb00b33b68f72261bc3f69df4a95d4244bd591f6 Mon Sep 17 00:00:00 2001
From: folex <0xdxdy@gmail.com>
Date: Thu, 20 Oct 2022 15:47:43 +0400
Subject: [PATCH] Add quick installation and example

---
 README.md | 27 ++++++++++++++++++++++++++-
 1 file changed, 26 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 0b405bf..e59d141 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,33 @@
 # Aqua IPFS bindings
 Native IPFS integration to Aqua language. Orchestrate IPFS file transfer with Aqua scripts.
 
+## Quick installation with @fluencelabs/cli
+```
+fluence dep npm i @fluencelabs/aqua-ipfs
+```
+
+## Quick Aqua example
+
+```
+import "@fluencelabs/aqua-ipfs/ipfs-api.aqua"
+import "@fluencelabs/aqua-lib/builtin.aqua"
+
+const PERIOD_SEC = 10
+
+func install_scheduled_script_from_ipfs_to_peer(from: PeerId, to: PeerId, cid: string) -> ?string:
+  script_id: ?string
+
+  ipfs_maddr <- get_external_api_multiaddr(from)
+  if ipfs_maddr.success:
+    get <- get_from(to, cid, ipfs_maddr.multiaddr)
+    if get.success:
+      script_id <- Script.add_from_vault(get.path, ?[PERIOD_SEC])
+
+  <- script_id
+```
+
 ## Documentation
-See [Aqua Book](https://fluence.dev/aqua-book/libraries/aqua-ipfs).
+See [aqua-ipfs in Aqua Book](https://fluence.dev/docs/aqua-book/libraries/aqua-ipfs).
 
 ## How to use it in TypeScript
 There's a simple example in [example](/example/index.ts)