README.md

Documentation: github.com/sagikazarmark/locafero

     1# Finder library for [Afero](https://github.com/spf13/afero)
     2
     3[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/sagikazarmark/locafero/ci.yaml?style=flat-square)](https://github.com/sagikazarmark/locafero/actions/workflows/ci.yaml)
     4[![go.dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=flat-square)](https://pkg.go.dev/mod/github.com/sagikazarmark/locafero)
     5![Go Version](https://img.shields.io/badge/go%20version-%3E=1.20-61CFDD.svg?style=flat-square)
     6[![built with nix](https://img.shields.io/badge/builtwith-nix-7d81f7?style=flat-square)](https://builtwithnix.org)
     7
     8**Finder library for [Afero](https://github.com/spf13/afero) ported from [go-finder](https://github.com/sagikazarmark/go-finder).**
     9
    10> [!WARNING]
    11> This is an experimental library under development.
    12>
    13> **Backwards compatibility is not guaranteed, expect breaking changes.**
    14
    15## Installation
    16
    17```shell
    18go get github.com/sagikazarmark/locafero
    19```
    20
    21## Usage
    22
    23Check out the [package example](https://pkg.go.dev/github.com/sagikazarmark/locafero#example-package) on go.dev.
    24
    25## Development
    26
    27**For an optimal developer experience, it is recommended to install [Nix](https://nixos.org/download.html) and [direnv](https://direnv.net/docs/installation.html).**
    28
    29Run the test suite:
    30
    31```shell
    32just test
    33```
    34
    35## License
    36
    37The project is licensed under the [MIT License](LICENSE).
View as plain text