diff --git a/README.md b/README.md index 4011781a7a2de1d8860f67d78e2fd74364aebfff..abf118fe4123b1a08bd13383aaedbe51edb454fd 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,21 @@ [](https://common.pages.km3net.de/KM3io.jl/dev) [](https://git.km3net.de/common/KM3io.jl/pipelines) [](https://git.km3net.de/common/KM3io.jl/commits/main) + +`KM3io.jl` is an pure Julia library which implements I/O functions and utilities +to deal with dataformats used in KM3NeT. + +## Installation + +`KM3Acoustics.jl` is not an officially registered Julia package but it's +available via the KM3NeT Julia registry. To add the KM3NeT Julia registry, +execute once: + + git clone https://git.km3net.de/common/julia-registry ~/.julia/registries/KM3NeT + +Once the registry is added, Julia will make sure to keep it up to date and pick +it whenever you install a package which is registered there. + +To install `KM3io.jl`: + + julia> import Pkg; Pkg.add("KM3io")