djdv/go-fs-lock

Filesystem based locking

go-fs-lock

Filesystem based locking

Lead Maintainer

Steven Allen

Table of Contents

• Install
• Usage
• Contribute
• License

Install

go-fs-lock is a standard Go module which can be installed with:

go get github.com/ipfs/go-fs-lock

Note that go-fs-lock is packaged with Gx, so it is recommended to use Gx to install and use it (see Usage section).

Usage

Using Gx and Gx-go

This module is packaged with Gx. In order to use it in your own project it is recommended that you:

go get -u github.com/whyrusleeping/gx
go get -u github.com/whyrusleeping/gx-go
cd <your-project-repository>
gx init
gx import github.com/ipfs/go-fs-lock
gx install --global
gx-go --rewrite

Please check Gx and Gx-go documentation for more information.

Running tests

Before running tests, please run:

make deps

This will make sure that dependencies are rewritten to known working versions.

Contribute

PRs are welcome!

Small note: If editing the Readme, please conform to the standard-readme specification.

License

MIT © Protocol Labs, Inc.