36533f7c3f
Fixes for new geth version |
||
---|---|---|
.. | ||
.travis.yml | ||
CODEOWNERS | ||
dir.go | ||
fd.go | ||
file.go | ||
go.mod | ||
go.sum | ||
inode.go | ||
LICENSE | ||
Makefile | ||
ops.go | ||
options.go | ||
package.json | ||
README.md | ||
repub.go | ||
root.go |
go-mfs
go-mfs implements an in-memory model of a mutable IPFS filesystem.
Table of Contents
Install
go-mfs
works like a regular Go module:
> go get github.com/ipfs/go-mfs
It uses Gx to manage dependencies. You can use make all
to build it with the gx
dependencies.
Usage
import "github.com/ipfs/go-mfs"
Check the GoDoc documentation
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:
Repository Structure
This repository contains many files, all belonging to the root mfs
package.
file.go
: MFSFile
.dir.go
: MFSDirectory
.fd.go
:FileDescriptor
used to operate onFile
s.ops.go
: Functions that do not belong to eitherFile
norDirectory
(although they mostly operate on them) that contain common operations to the MFS, e.g., find, move, add a file, make a directory.root.go
: MFSRoot
(aDirectory
with republishing support).repub.go
:Republisher
.mfs_test.go
: General tests (needs a revision).repub_test.go
: Republisher-specific tests (contains only theTestRepublisher
function).
Contribute
PRs accepted.
Small note: If editing the README, please conform to the standard-readme specification.
License
MIT © Protocol Labs, Inc.