Update docs for v0.0.101 (#5)

PacificBiosciences · Feb 27, 2022 · 025216e · 025216e
1 parent d7c7e65
commit 025216e
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -6,5 +6,8 @@ nav_order: 99
 
 # Version changelog
 
+**0.0.101**
+   * Update to CLI
+
 **0.0.100**
    * Alpha release of `skera`
diff --git a/docs/index.md b/docs/index.md
@@ -33,9 +33,18 @@ page](https://github.com/PacificBiosciences/pbbioconda) for information on
 Installation, Support, License, Copyright, and Disclaimer.
 
 ## Versions
-Version **0.0.100**: [Full changelog here](/changelog)
+Version **0.0.101**: [Full changelog here](/changelog)
+
+## Input
+### Reads
+HiFi reads in PacBio BAM format.
+
+### Adapters
+Adapters must be in FASTA format `<adapters.fasta>` and ordered in the expected 
+order of adapters in the reads. There should be one entry per adapter (forward 
+or reverse-complement orientation) with no overlapping adapter sequences. 
 
 ## Execution
 Skera run on HiFi reads in PacBio BAM format:
 
-    skera --algorithm kmer <movie>.hifi_reads.bam adapters.fasta <movie>.skera.bam
+    skera <movie>.hifi_reads.bam adapters.fasta <movie>.skera.bam