Update README with updated usage

adelq · Jan 2, 2018 · 3ba0d65 · 3ba0d65
1 parent a734799
commit 3ba0d65
Showing 1 changed file with 6 additions and 3 deletions.
diff --git a/README.rst b/README.rst
@@ -8,7 +8,8 @@ dN/dS Calculator
     :target: https://pypi.python.org/pypi/dnds
 
 Calculate dN/dS ratio precisely (Ka/Ks) using a codon-by-codon counting
-method.
+method. Also calculates the pN/pS ratio precisely (previously referred to as
+dN/dS).
 
 Usage
 -----
@@ -17,7 +18,9 @@ Usage
 
     >>> sequence_1 = "ATGCTTTTGAAATCG"
     >>> sequence_2 = "ATGCGTTCGAAGTCG"
-    >>> dnds(sequence_1, sequence2)
+    >>> pnps(sequence_1, sequence2)
     Fraction(38, 71)
-    >>> round(float(dnds(sequence_1, sequence2)), 3)
+    >>> round(float(pnps(sequence_1, sequence2)), 3)
     0.535
+    >>> round(dnds(sequence_1, sequence_2), 3)
+    0.467