commit 08ed7f2b5666221d0d1185f253e2f1da7a4fc738
author Marc Kupietz <kupietz@ids-mannheim.de> Thu Jul 21 15:32:57 2022 +0200
committer Marc Kupietz <kupietz@ids-mannheim.de> Thu Jul 21 15:43:28 2022 +0200
tree 69202909b23c1b70789a10ee2b63dd8657c6e460
parent 41b0f68d72abc3baa7994148c14c095b50d87040

Update Readme

Change-Id: I75c5e98114f92b342f4e085c26b540168b3eaee9

README.md

diff --git a/README.md b/README.md
index 728c1ae..ca3f88e 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,27 @@
-# DerekoVecs
+# DerekoVecs.jl
 
-[![Build Status](https://github.com/kupietz@ids-mannheim.de/DerekoVecs.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/kupietz@ids-mannheim.de/DerekoVecs.jl/actions/workflows/CI.yml?query=branch%3Amain)
+Minimal Julia package to load and use [dereko2vec](https://korap.ids-mannheim.de/gerrit/plugins/gitiles/ids-kl/dereko2vec) language models.
+
+Currently, only paradigmatic analysis is supported.
+
+## Installation
+
+```Julia
+pkg> add "https://korap.ids-mannheim.de/gerrit/ids-kl/DerekoVecs.jl"
+```
+
+## Example Usage
+
+```Julia
+using DerekoVecs
+
+model = load("model.vecs")
+
+knn(model, "interessant", 10)
+
+cos_dist(model, "gut", "besser")
+```
+
+## License
+
+This packages is licensed under Apache 2.0