From 777ea2151c870dbf4d2c44f998e3fd23f9d9e00d Mon Sep 17 00:00:00 2001 From: Lucas Molas Date: Tue, 18 Dec 2018 12:02:19 -0300 Subject: [PATCH] add documentation links in README --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 86c9d9b..da0dcdf 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,14 @@ import "github.com/ipfs/go-mfs" Check the [GoDoc documentation](https://godoc.org/github.com/ipfs/go-mfs) +## Documentation + +Documentation around the MFS and the Files API in general around IPFS is a work in progress the following links may be of use: + +* [UnixFS](https://docs.ipfs.io/guides/concepts/unixfs/) +* [MFS](https://docs.ipfs.io/guides/concepts/mfs/) +* [General concept document about how are files handled in IPFS (WIP)](https://github.com/ipfs/docs/issues/133) + ## Repository Structure This repository contains many files, all belonging to the root `mfs` package.