https://rs-ipfs.github.io/offchain-ipfs-manual/

https://rs-ipfs.github.io/offchain-ipfs-manual/

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://rs-ipfs.github.io/offchain-ipfs-manual/
• Owner: rs-ipfs
• Created: 2020-10-14T18:09:46.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2020-11-16T16:46:09.000Z (about 4 years ago)
• Last Synced: 2024-10-30T03:25:31.711Z (about 1 month ago)
• Language: Rust
• Size: 1.26 MB
• Stars: 0
• Watchers: 4
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-substrate - `offchain::ipfs` - Substrate infused with [IPFS](https://ipfs.io/). (Tools)
• awesome-substrate - `offchain::ipfs` - Substrate infused with [IPFS](https://ipfs.io/). (Tools)

README

        
# The `offchain::ipfs` Manual

## Table of Contents

- [Usage](#usage)

- [Install](#install)

- [Contributing](#contributing)

- [License](#license)

## Usage

Visit [https://rs-ipfs.github.io/offchain-ipfs-manual] to read the book.

[https://rs-ipfs.github.io/offchain-ipfs-manual]: https://rs-ipfs.github.io/offchain-ipfs-manual

## Install

You can install and run locally if you want to contribute.

First, install [`mdbook`](https://rust-lang.github.io/mdBook/cli/index.html). Then:

```bash

git clone https://github.com/rs-ipfs/offchain-ipfs-manual

cd offchain-ipfs-manual

mdbook serve

```

This will open up a version of the book on localhost, port 3000

## Contributing

PRs accepted.

To run linting locally, run:

```bash

npx markdownlint-cli src README.md

```

## License

TBD © 2020 Rust IPFS Maintainers