From b96352e266367544fe8d3bdf4f0e788244da7b0d Mon Sep 17 00:00:00 2001
From: Rowena Hill <34376457+Rowena-h@users.noreply.github.com>
Date: Wed, 24 Nov 2021 14:04:19 +0000
Subject: [PATCH] Update README.md

---
 README.md | 32 ++++++++++++++++++++++++++++++--
 1 file changed, 30 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index a7da593..f1efb2a 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,31 @@
-# FungusNameCheck
+# FungusNameCheck.R
 
-Rscript FungusNameCheck.R file.csv 2>&1 | tee log
+A tool to check fungus names for the most up to date classification according to [Species Fungorum](http://www.speciesfungorum.org/).
+
+## Requirements
+
+FungusNameCheck.R is an [R](https://www.r-project.org/) script (written in R v4.1.1) designed to run in the linux command line.
+
+It requires the [**taxize**](https://github.com/ropensci/taxize) R package.
+
+To download:
+
+```
+git clone https://github.com/Rowena-h/FungusNameCheck.git
+```
+
+## Usage
+
+The only input needed is a file containing a list of names to check **without a header**. To see an example, refer to [example/list](example/list).
+
+To run the script:
+
+```
+Rscript FungusNameCheck.R example/list
+```
+
+To run the script and additionally produce a log file:
+
+```
+Rscript FungusNameCheck.R example/list 2>&1 | tee log
+```