diff --git a/README.md b/README.md index 697ee79..f241531 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # AxisKeysExtra.jl -The [AxisKeys.jl](https://github.com/mcabbott/AxisKeys.jl) package provides a nice lightweight `KeyedArray` structure: arrays with keyed/labelled axes, similar to `xarray` in Python. +The [AxisKeys.jl](https://github.com/mcabbott/AxisKeys.jl) package provides a nice lightweight `KeyedArray` structure: arrays with keyed/labelled axes, similar to `xarray` in Python. \ It is being maintained, but proposed new features – even simple and self-contained ones – aren't being added ([see, e.g.](https://github.com/mcabbott/AxisKeys.jl/pull/110)). That's the reason for this package, `AxisKeysExtra.jl`: it extends `AxisKeys` with new convenience functions, conversions, Makie plotting recipes. + +The intended usage is to just do `using AxisKeysExtra`: it reexports `AxisKeys`, so one can use both regular `AxisKeys` functionality and functions defined in this package.\ See [the Pluto notebook](https://aplavin.github.io/AxisKeysExtra.jl/test/notebook.html) for details and examples.