mirror of
https://github.com/NotAShelf/batmon.git
synced 2024-11-26 23:26:48 +00:00
38 lines
1.4 KiB
Markdown
38 lines
1.4 KiB
Markdown
# Finder library for [Afero](https://github.com/spf13/afero)
|
|
|
|
[](https://github.com/sagikazarmark/locafero/actions/workflows/ci.yaml)
|
|
[](https://pkg.go.dev/mod/github.com/sagikazarmark/locafero)
|
|
|
|
[](https://builtwithnix.org)
|
|
|
|
**Finder library for [Afero](https://github.com/spf13/afero) ported from [go-finder](https://github.com/sagikazarmark/go-finder).**
|
|
|
|
> [!WARNING]
|
|
> This is an experimental library under development.
|
|
>
|
|
> **Backwards compatibility is not guaranteed, expect breaking changes.**
|
|
|
|
## Installation
|
|
|
|
```shell
|
|
go get github.com/sagikazarmark/locafero
|
|
```
|
|
|
|
## Usage
|
|
|
|
Check out the [package example](https://pkg.go.dev/github.com/sagikazarmark/locafero#example-package) on go.dev.
|
|
|
|
## Development
|
|
|
|
**For an optimal developer experience, it is recommended to install [Nix](https://nixos.org/download.html) and [direnv](https://direnv.net/docs/installation.html).**
|
|
|
|
Run the test suite:
|
|
|
|
```shell
|
|
just test
|
|
```
|
|
|
|
## License
|
|
|
|
The project is licensed under the [MIT License](LICENSE).
|