From 02ef6d2b8602cc5ae6b8c207a7da12bd53b535d1 Mon Sep 17 00:00:00 2001 From: Gibraan Rahman Date: Tue, 5 Apr 2022 15:30:25 -0700 Subject: [PATCH] update README --- README.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index c1dec52..1bc0d60 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ [![Main CI](https://github.com/gibsramen/xebec/actions/workflows/main_ci.yml/badge.svg)](https://github.com/gibsramen/xebec/actions/workflows/main_ci.yml) +[![PyPI](https://img.shields.io/pypi/v/xebec.svg)](https://pypi.org/project/xebec) # xebec @@ -11,7 +12,7 @@ Snakemake pipeline for microbiome diversity effect size benchmarking To use xebec, you will need several dependencies. We recommend using [`mamba`](https://github.com/mamba-org/mamba) to install these packages when possible. -```bash +``` mamba install -c conda-forge -c bioconda biom-format h5py==3.1.0 snakemake pandas unifrac scikit-bio bokeh cookiecutter unifrac-binaries pip install evident>=0.2.0 gemelli>=0.0.8 @@ -19,17 +20,15 @@ pip install evident>=0.2.0 gemelli>=0.0.8 To install xebec, run the following command from the command line: -```bash -git clone git@github.com:gibsramen/xebec.git -cd xebec -pip install . +``` +pip install xebec ``` ## Usage If you run `xebec --help`, you should see the following: -```bash +``` $ xebec --help Usage: xebec [OPTIONS] @@ -103,7 +102,7 @@ If this pipeline runs sucessfully, the processed results will be located at `