From c25f4ab9a14920c6c6cef8303fd5aa472fd91ac0 Mon Sep 17 00:00:00 2001 From: Harrison Deng Date: Tue, 27 Jun 2023 14:40:33 +0000 Subject: [PATCH] Updated the 'README.md' --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9fc016f..2055907 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,9 @@ -# A Generic Python Program Template +# ModVCFSamples -This template is meant to be a general starting point for any Python program. It contains Jenkins configurations, Conda environment starter files, all the variations of a Python's project configurations, and pytests. \ No newline at end of file +This is a simple CLI program that allows users to edit rapidly modify VCF files to conform to a certain format. + +## Install + +1. Run the following in any terminal with `pip` installed: `pip install --index-url https://git.reslate.systems/api/packages/ydeng/pypi/simple/ modvcfsamples` + +2. Use `modvcfsamples -h` to see help. \ No newline at end of file