update readme

Author: lmdu

.github/workflows/main.yml

@@ -22,7 +22,8 @@ jobs:
         run: python -m cibuildwheel --output-dir wheelhouse
         env:
           CIBW_SKIP: cp27-* pp27-*
-          CIBW_BUILD_VERBOSITY: 3
+          CIBW_BUILD_VERBOSITY: 0
+          #CIBW_BUILD_VERBOSITY: 3 for debug
 
       - name: Display wheel
         run: ls -l wheelhouse
@@ -55,8 +56,7 @@ jobs:
   upload_pypi:
     needs: [build_wheels, build_sdist]
     runs-on: ubuntu-latest
-    if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags/v')
-    #if: github.event_name == 'push'
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
     steps:
       - uses: actions/download-artifact@v2
         with:

README.rst

@@ -28,6 +28,17 @@ The ``stria`` is a lightweight Python C extension for identification and analysi
 The ``stria`` enables to fastly identify both exact and imperfect SSRs and VNTRs from large numbers of DNA sequences.
 The ``stria`` also provides command line tools for users to extract tandem repeats from Fasta files.
 
+Usage
+=====
+
+.. code:: python
+
+	>>> import stria
+	>>> import pyfastx
+	>>> for name, seq, _ in pyfastx.Fastx('test.fa.gz'):
+	>>> 	for ssr in SSRMiner(name, seq):
+	>>> 		print(ssr.as_string())
+
 Documentation
 =============