From 0fb8cf30b1b5ed19278ecc927316032f7bea2fb9 Mon Sep 17 00:00:00 2001
From: pmc4 <117096890+pmc4@users.noreply.github.com>
Date: Fri, 15 Dec 2023 14:36:25 +0100
Subject: [PATCH] Add a brief description to the README

Because
* Even though the tutorial is not uploaded, someone may want to install
the package.
---
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/README.md b/README.md
index 03bf3fa..dace1c2 100644
--- a/README.md
+++ b/README.md
@@ -5,3 +5,14 @@
 [![Build Status](https://github.com/pmc4/VectorPlotDigitizer.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/pmc4/VectorPlotDigitizer.jl/actions/workflows/CI.yml?query=branch%3Amain)
 [![Coverage](https://codecov.io/gh/pmc4/VectorPlotDigitizer.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/pmc4/VectorPlotDigitizer.jl)
 [![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
+
+WIP package. Documentation and tutorials will be upload it in the future, sorry for the inconvenience.
+
+The idea of VectorPlotDigitizer is to be able to digitize the data of plots that are given in a vector format, such as SVG or PDF.
+
+To install it enter Pkg mode in a Julia terminal by writing `]` and write `add VectorPlotDigitizer` or use
+
+```julia
+using Pkg
+Pkg.add(VectorPlotDigitizer)
+```
\ No newline at end of file