Skip to content

Commit

Permalink
upd readme
Browse files Browse the repository at this point in the history
  • Loading branch information
aplavin committed May 6, 2024
1 parent 65381a3 commit 0000000
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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.

2 comments on commit 0000000

@aplavin
Copy link
Member Author

@aplavin aplavin commented on 0000000 May 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register()

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/106288

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.9 -m "<description of version>" 00000000ce319ee7406cc9ff7887a74186246c7d
git push origin v0.1.9

Also, note the warning: This looks like a new registration that registers version 0.1.9.
Ideally, you should register an initial release with 0.0.1, 0.1.0 or 1.0.0 version numbers
This can be safely ignored. However, if you want to fix this you can do so. Call register() again after making the fix. This will update the Pull request.

Please sign in to comment.