b08b3aba64
Updated READMEs, removed docs and point everything to website documentation. License: MIT Signed-off-by: Hector Sanjuan <code@hector.link>
66 lines
2.8 KiB
Markdown
66 lines
2.8 KiB
Markdown
# IPFS Cluster
|
|
|
|
|
|
[](https://protocol.ai)
|
|
[](http://github.com/ipfs/ipfs)
|
|
[](http://webchat.freenode.net/?channels=%23ipfs-cluster)
|
|
[](https://github.com/RichardLitt/standard-readme)
|
|
[](https://godoc.org/github.com/ipfs/ipfs-cluster)
|
|
[](https://goreportcard.com/report/github.com/ipfs/ipfs-cluster)
|
|
[](https://travis-ci.org/ipfs/ipfs-cluster)
|
|
[](https://coveralls.io/github/ipfs/ipfs-cluster?branch=master)
|
|
|
|
> Pinset orchestration for IPFS.
|
|
|
|
<p align="center">
|
|
<img src="https://cluster.ipfs.io/cluster/png/IPFS_Cluster_color_no_text.png" alt="logo" width="300" height="300" />
|
|
</p>
|
|
|
|
IPFS Cluster allows to allocate, replicate and track Pins across a cluster of IPFS daemons.
|
|
|
|
It provides:
|
|
|
|
* A cluster peer application: `ipfs-cluster-service`, to be run along with `go-ipfs`.
|
|
* A client CLI application: `ipfs-cluster-ctl`, which allows easily interacting with the peer's HTTP API.
|
|
|
|
## Table of Contents
|
|
|
|
- [Documentation](#documentation)
|
|
- [News & Roadmap](#news--roadmap)
|
|
- [Install](#install)
|
|
- [Usage](#usage)
|
|
- [Contribute](#contribute)
|
|
- [License](#license)
|
|
|
|
|
|
## Documentation
|
|
|
|
Please visit https://cluster.ipfs.io/documentation/ to access user documentation, guides and any other resources, including detailed **download** and **usage** instructions.
|
|
|
|
## News & Roadmap
|
|
|
|
We regularly post project updates to https://cluster.ipfs.io/news/ .
|
|
|
|
The most up-to-date *Roadmap* is available at https://cluster.ipfs.io/roadmap/ .
|
|
|
|
## Install
|
|
|
|
Instructions for different installation methods (including from source) are available at https://cluster.ipfs.io/documentation/download .
|
|
|
|
## Usage
|
|
|
|
Extensive usage information is provided at https://cluster.ipfs.io/documentation/ , including:
|
|
|
|
* [Docs for `ipfs-cluster-service`](https://cluster.ipfs.io/documentation/ipfs-cluster-service/)
|
|
* [Docs for `ipfs-cluster-ctl`](https://cluster.ipfs.io/documentation/ipfs-cluster-ctl/)
|
|
|
|
## Contribute
|
|
|
|
PRs accepted. As part of the IPFS project, we have some [contribution guidelines](https://cluster.ipfs.io/developer/contribute).
|
|
|
|
Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
|
|
|
|
## License
|
|
|
|
MIT © Protocol Labs, Inc.
|