Explain usage

Edinburgh-Genome-Foundry · Apr 15, 2024 · b4c302f · b4c302f
1 parent dfd7236
commit b4c302f
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -20,8 +20,16 @@ pip install git+https://github.com/Edinburgh-Genome-Foundry/Seq_Report.git
 
 ```python
 import seqreport
+
+seq_fasta = "seq.fa"
+seq_coll = seqreport.SeqCollection(fasta=seq_fasta, projectname="EGF24")
+seqreport.write_pdf_report("seq_report.pdf", seq_coll)
 ```
 
+<p align="center">
+<img alt="Seq Report" title="Seq Report" src="images/seqreport_screenshot.png" width="360">
+</p>
+
 ## Versioning
 
 Seq Report uses the [semantic versioning](https://semver.org) scheme.

diff --git a/images/seqreport_screenshot.png b/images/seqreport_screenshot.png