History

Elizabeth Engelman 36533f7c3f Update vendor directory and make necessary code changes Fixes for new geth version		2019-09-25 16:32:27 -05:00
..
.gitignore	Update vendor directory and make necessary code changes	2019-09-25 16:32:27 -05:00
.travis.yml	Update vendor directory and make necessary code changes	2019-09-25 16:32:27 -05:00
fslock.go	Update vendor directory and make necessary code changes	2019-09-25 16:32:27 -05:00
go.mod	Update vendor directory and make necessary code changes	2019-09-25 16:32:27 -05:00
go.sum	Update vendor directory and make necessary code changes	2019-09-25 16:32:27 -05:00
LICENSE	Update vendor directory and make necessary code changes	2019-09-25 16:32:27 -05:00
package.json	Update vendor directory and make necessary code changes	2019-09-25 16:32:27 -05:00
README.md	Update vendor directory and make necessary code changes	2019-09-25 16:32:27 -05: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.