From 0d7a80033e895a1beb485b256ee615dcd91f42e5 Mon Sep 17 00:00:00 2001
From: ktpolanski <krzysztof_polanski@o2.pl>
Date: Tue, 1 Aug 2023 09:35:41 +0000
Subject: [PATCH] links in toml and readme

---
 README.md      | 8 ++++----
 pyproject.toml | 2 ++
 2 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index cb22adf..4d29fa5 100644
--- a/README.md
+++ b/README.md
@@ -15,15 +15,15 @@
 ## Installation
 
 ```bash
-pip install git+https://github.com/Teichlab/sctk.git
+pip install sctk
 ```
 
-It is recommended to install sctk into a fresh python 3.9 virtual environment due to its large amount of dependencies. If you encounter a dependency conflict when installing into a fresh environment, try updating pip:
+If you encounter dependency clashes, create a fresh python 3.9 virtual environment (e.g. via conda) and install SCTK there. It may also help to update pip:
 
 ```bash
 pip install --upgrade pip
 ```
 
-## Usage
+## Usage and Documentation
 
-An example of applying the automatic QC workflow can be found in the [demo notebook](notebooks/automatic_qc.ipynb).
+SCTK's documentation is available [here](https://teichlab.github.io/sctk/), and features a tutorial and API reference for the automated QC workflow.
diff --git a/pyproject.toml b/pyproject.toml
index 55efa0f..bec517f 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -9,6 +9,8 @@ authors = [
 ]
 license = "GPL-3.0"
 readme = "README.md"
+homepage = "https://github.com/Teichlab/sctk"
+documentation = "https://teichlab.github.io/sctk/"
 
 [tool.poetry.dependencies]
 python = "^3.9"