From 3d7bbb9c06a745f72a1ba434f911b21b3f0e497e Mon Sep 17 00:00:00 2001 From: ChocoParrot Date: Mon, 13 Sep 2021 21:42:45 +0800 Subject: [PATCH] [refactor] readme changes --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 45b23a6..9b840ed 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,12 @@ Finds the open reading frame (6-frame scan) on a given 5' to 3' nucleotide. ### Installation: `pip3 install orffinder` -### Usage +### Terminal Usage +Two command-line executable commands are available: `orffinder-to-gtf` `orffinder-to-sequence`. + +Documentation for these commands can be retrieved by specifying ` -h`. + +### API Usage Import the package **IMPORTANT: Your DNA/RNA strand should always be from the 5' to 3' direction when input!**