From 31bc10ab99eced919d21d5bae62235f98c659589 Mon Sep 17 00:00:00 2001
From: Vijini Mallawaarachchi <viji.mallawaarachchi@gmail.com>
Date: Sat, 6 Jul 2024 21:31:23 +0930
Subject: [PATCH] DOC: Update README.md

---
 README.md | 28 +++++++++++++++++++++++++++-
 1 file changed, 27 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 480b201..c1d4217 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,8 @@
 ![GitHub License](https://img.shields.io/github/license/anuradhawick/kmertools)
 [![Cargo tests](https://github.com/anuradhawick/kmertools/actions/workflows/rust_test.yml/badge.svg)](https://github.com/anuradhawick/kmertools/actions/workflows/rust_test.yml)
 [![Clippy check](https://github.com/anuradhawick/kmertools/actions/workflows/clippy_check.yml/badge.svg)](https://github.com/anuradhawick/kmertools/actions/workflows/clippy_check.yml)
+![Conda](https://img.shields.io/conda/v/bioconda/kmertools)
+![Conda](https://img.shields.io/conda/dn/bioconda/kmertools)
 [![codecov](https://codecov.io/gh/anuradhawick/kmertools/graph/badge.svg?token=IDGRE54SSQ)](https://codecov.io/gh/anuradhawick/kmertools)
 
 <div align="center">
@@ -22,6 +24,8 @@ $$ | \$$\ $$ | $$ | $$ |\$$$$$$$\ $$ |         $$ |   \$$$$$$  |\$$$$$$  |$$ |$$
 
 `kmertools` is a k-mer based feature extraction tool designed to support metagenomics and other bioinformatics analytics. This tool leverages k-mer analysis to vectorize DNA sequences, facilitating the use of these vectors in various AI/ML applications.
 
+**NEW:** `kmertools` is not available on bioconda at [https://anaconda.org/bioconda/kmertools](https://anaconda.org/bioconda/kmertools).
+
 ## Features
 
 - **Oligonucleotide Frequency Vectors:** Generate frequency vectors for oligonucleotides.
@@ -31,6 +35,20 @@ $$ | \$$\ $$ | $$ | $$ |\$$$$$$$\ $$ |         $$ |   \$$$$$$  |\$$$$$$  |$$ |$$
 
 ## Installation
 
+### Option 1: from bioconda (recommended)
+
+You can install `kmertools` from Bioconda at https://anaconda.org/bioconda/kmertools. Make sure you have [conda](https://docs.conda.io/en/latest/) installed.
+
+```bash
+# create conda environment and install kmertools
+conda create -n kmertools -c bioconda kmertools
+
+# activate environment
+conda activate kmertools
+```
+
+### Option 2: from sources
+
 You can install `kmertools` directly from the source by cloning the repository and using Rust's package manager `cargo`.
 
 ```bash
@@ -54,6 +72,14 @@ echo "export PATH=\$PATH:$(pwd)/target/release/" >> ~/.zshrc
 source ~/.zshrc
 ```
 
+## Test the installation
+
+After setting up, run the following command to print out the `kmertools` help message.
+
+```bash
+kmertools --help
+```
+
 ## Help
 
 Please read our comprehensive [Wiki](https://github.com/anuradhawick/kmertools/wiki).
@@ -65,4 +91,4 @@ Please read our comprehensive [Wiki](https://github.com/anuradhawick/kmertools/w
 
 ## Support and contributions
 
-Please get in touch via author websites or GitHub issues. Thanks!
\ No newline at end of file
+Please get in touch via author websites or GitHub issues. Thanks!