From 615e612c7432c65fe02ffdc3c6db6bcddc44bf55 Mon Sep 17 00:00:00 2001
From: Raimon Tolosana-Delgado <tolosa53@fwg206.ad.fz-rossendorf.de>
Date: Wed, 5 Aug 2020 15:20:12 +0200
Subject: [PATCH] minimal readme

---
 .gitignore | 1 +
 README.md  | 8 +++++++-
 2 files changed, 8 insertions(+), 1 deletion(-)

diff --git a/.gitignore b/.gitignore
index c066a39..8e3a7fd 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1 +1,2 @@
 inst/doc
+.Rproj.user
diff --git a/README.md b/README.md
index 9fabdcb..4b04e5f 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,8 @@
-# gmGeostats
+# gmGeostats: Geostatistics for Compositional Analysis with R
+
+This R package offers support for geostatistical analysis of multivariate data, in particular data with restrictions, e.g. positive amounts data, compositional data, distributional data, microstructural data, etc. It includes descriptive analysis and modelling for such data, both from a two-point Gaussian perspective and multipoint perspective. The package is devised for supporting 3D, multi-scale and large data sets and grids. This is a building block of the suite of HIF geometallurgical software.
+
+## More information 
+
+Read the (./vignettes/gmGeostats.html)[vignette] for a scheme of the package functionality.
 
-- 
GitLab