Polish the static docs

1 files changed, 16 insertions, 5 deletions

diff --git a/README.md b/README.md
index 2430f79..fc01182 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,19 @@
----
-title: Readme file for the drfit R package
----
+# drfit
 
 [![](https://www.r-pkg.org/badges/version/drfit)](https://cran.r-project.org/package=drfit)
 
-Static documentation of this R package can be found at
-https://pkgdown.jrwb.de/drfit
+A somewhat outdated package of basic and easy-to-use functions for
+fitting dose-response curves to continuous dose-response data, calculating some
+toxicological parameters and plotting the results. Please consider using
+the more powerful and actively developed 'drc' package.  
+
+Functions that are fitted are the cumulative density function of the log-normal
+distribution ('probit' fit), of the logistic distribution ('logit' fit), of the
+Weibull distribution ('weibull' fit) and a linear-logistic model ('linlogit'
+fit), derived from the latter, which is used to describe data showing
+stimulation at low doses (hormesis). In addition, functions checking, plotting
+and retrieving dose-response data retrieved from a database accessed via 'odbc'
+are included. As an alternative to the original fitting methods, the algorithms
+from the 'drc' package can be used.
+
+More details can be found in the [function referenc](reference/index.html).