Skip to content

Commit

Permalink
docs: clean readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ldez committed Jun 26, 2024
1 parent afee741 commit af1629c
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,9 @@
[![License](https://img.shields.io/badge/license-BSD_3--Clause-brightgreen.svg?style=flat)](https://github.com/gofrs/flock/blob/master/LICENSE)
[![Go Report Card](https://goreportcard.com/badge/github.com/gofrs/flock)](https://goreportcard.com/report/github.com/gofrs/flock)

`flock` implements a thread-safe sync.Locker interface for file locking.
It also includes a non-blocking `TryLock()` function to allow locking without blocking execution.

## License

`flock` is released under the BSD 3-Clause License. See the `LICENSE` file for more details.
`flock` implements a thread-safe `sync.Locker` interface for file locking.

## Go Compatibility

This package makes use of the `context` package that was introduced in Go 1.7.
As such, this package has an implicit dependency on Go 1.7+.
It also includes a non-blocking `TryLock()` function to allow locking without blocking execution.

## Installation

Expand Down Expand Up @@ -43,3 +35,14 @@ if locked {

For more detailed usage information take a look at the package API docs on
[GoDoc](https://pkg.go.dev/github.com/gofrs/flock).

## License

`flock` is released under the BSD 3-Clause License. See the [`LICENSE`](./LICENSE) file for more details.

## Project History

(originally github.com/theckman/go-flock)

This project was originally `github.com/theckman/go-flock`, it was transferred to Gofrs by the original author [Tim Heckman ](https://github.com/theckman).

0 comments on commit af1629c

Please sign in to comment.