From ecf68f318e137d59e0ce83ec701e99fc32617894 Mon Sep 17 00:00:00 2001 From: David Gasquez Date: Tue, 30 May 2023 12:18:39 +0200 Subject: [PATCH] add installation instructions --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 9fe2c1a..0519cbb 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,15 @@ A readonly implementation of fsspec for IPFS. +## Installation + +You can install `ipfsspec` directly from git with the following command: +```bash +pip install git+https://github.com/fsspec/ipfsspec +``` + +## Usage + This project is currently very rudimentaty. It is not yet optimized for efficiency and is not yet feature complete. However it should be enough to list directory contents and to retrieve files from `ipfs://` resources via fsspec. A simple hello worlds would look like: ```python