add README

JuliaAPlavin · May 6, 2024 · 9d70805 · 9d70805
1 parent 1581793
commit 9d70805
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,5 @@
 # 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.
+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.
+See [the Pluto notebook](https://aplavin.github.io/AxisKeysExtra.jl/test/notebook.html) for details and examples.