From f59b28433a0e74d577a52ebedc4bb51a3fad85f9 Mon Sep 17 00:00:00 2001
From: Tamas Gal <himself@tamasgal.com>
Date: Fri, 16 Dec 2022 00:20:48 +0100
Subject: [PATCH] Update readme

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/README.md b/README.md
index 4011781a..abf118fe 100644
--- a/README.md
+++ b/README.md
@@ -3,3 +3,21 @@
 [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://common.pages.km3net.de/KM3io.jl/dev)
 [![Build Status](https://git.km3net.de/common/KM3io.jl/badges/main/pipeline.svg)](https://git.km3net.de/common/KM3io.jl/pipelines)
 [![Coverage](https://git.km3net.de/common/KM3io.jl/badges/main/coverage.svg)](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")
-- 
GitLab