From ba9fbdf0df19c257315ec53926514c00ad140646 Mon Sep 17 00:00:00 2001
From: Elias Projahn <elias@johrpan.de>
Date: Thu, 2 Jun 2022 19:30:31 +0200
Subject: [PATCH] Add readme

---
 DESCRIPTION |  4 ++--
 README.md   | 41 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 43 insertions(+), 2 deletions(-)
 create mode 100644 README.md

diff --git a/DESCRIPTION b/DESCRIPTION
index 9b73d2a..c732b2a 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -1,5 +1,5 @@
 Package: ubigen
-Title: Graphical Interface for Finding Patterns in Gene Expression
+Title: Graphical Interface for Finding Ubiquitous Genes
 Version: 0.0.0.9000
 Authors@R:
     person(
@@ -11,7 +11,7 @@ Authors@R:
     )
 Description: This package contains precomputed data including comparisons in
     gene expression. It provides a graphical interface to analyze and visualize
-    those data.
+    those data to rank genes based on how ubiquitously expressed they are.
 License: AGPL (>= 3)
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0f24f17
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# Ubigen
+
+This R package contains precomputed data including comparisons in gene
+expression within the [GTEx database](https://gtexportal.org). It provides a
+graphical interface to analyze and visualize those data to rank genes based on
+how ubiquitously expressed they are.
+
+## Installation
+
+You can install the development version of `ubigen` using:
+
+```r
+# install.packages("remotes")
+remotes::install_git("https://code.johrpan.de/johrpan/ubigen.git")
+```
+
+## Usage
+
+You only need one function to get started. It will run the application and
+serve the graphical user interface which can be viewed using your preferred
+web browser.
+
+```r
+ubigen::run_app()
+```
+
+For additional information, take a look at the built-in documentation
+(`?ubigen::run_app`).
+
+## License
+
+This program is free software: you can redistribute it and/or modify it under
+the terms of the GNU Affero General Public License as published by the Free
+Software Foundation, either version 3 of the License, or (at your option) any
+later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+PARTICULAR PURPOSE. See the
+[GNU Affero General Public License}(https://www.gnu.org/licenses/agpl-3.0.html)
+for more details.