History

Ian Norden d702cb720c update dependencies to work with update eth-block-extractor		2019-12-02 13:24:49 -06:00
..
.gitignore	update dependencies to work with update eth-block-extractor	2019-12-02 13:24:49 -06:00
.travis.yml	update dependencies to work with update eth-block-extractor	2019-12-02 13:24:49 -06:00
fslock.go	update dependencies to work with update eth-block-extractor	2019-12-02 13:24:49 -06:00
go.mod	update dependencies to work with update eth-block-extractor	2019-12-02 13:24:49 -06:00
go.sum	update dependencies to work with update eth-block-extractor	2019-12-02 13:24:49 -06:00
LICENSE	update dependencies to work with update eth-block-extractor	2019-12-02 13:24:49 -06:00
package.json	update dependencies to work with update eth-block-extractor	2019-12-02 13:24:49 -06:00
README.md	update dependencies to work with update eth-block-extractor	2019-12-02 13:24:49 -06:00

README.md

go-fs-lock

Filesystem based locking

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.