Skip to content

Commit

Permalink
add installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
davidgasquez committed May 30, 2023
1 parent 2a73d5e commit ecf68f3
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit ecf68f3

Please sign in to comment.