Commit 728bd73e authored by alexm98's avatar alexm98

Added some documentation.

parent a03e6f0b
# cl-ipfs
An IPFS API client written in Common Lisp as an asdf system.
## Functions
### (cl-ipfs:add "/path/to/file")
---
Input: Valid path for a file located on the current filesystem.
Output: an IPFS hash.
### (cl-ipfs:ls "hash")
---
Input : an IPFS hash.
Output: IPFS hashes to the links (that is links to the other parts of the uploaded file.)
### (cl-ipfs:cat "hash")
---
Input : an IPFS hash.
Output: a raw byte-stream of the data.
Input : an IPFS hash.
### (cl-ipfs:size "hash")
---
Input : an IPFS hash.
Output: file size in bits.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment