added readme

Author: lmdu

.github/workflows/main.yml

@@ -55,8 +55,8 @@ 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.event.ref, 'refs/tags/v')
+    #if: github.event_name == 'push'
     steps:
       - uses: actions/download-artifact@v2
         with:
@@ -66,5 +66,5 @@ jobs:
       - uses: pypa/gh-action-pypi-publish@master
         with:
           user: __token__
-          password: ${{ secrets.PYPI_TEST_API_TOKEN }}
-          repository_url: https://test.pypi.org/legacy/
+          password: ${{ secrets.PYPI_API_TOKEN }}
+          #repository_url: https://test.pypi.org/legacy/

README.rst

@@ -1,2 +1,34 @@
-# strit
-short tandem repeat identification tool
+stria
+#####
+
+.. image:: https://github.com/lmdu/stria/actions/workflows/main.yml/badge.svg
+   :target: https://github.com/lmdu/stria/actions/workflows/main.yml
+   :alt: Github Action
+
+.. image:: https://readthedocs.org/projects/stria/badge/?version=latest
+   :target: https://stria.readthedocs.io/en/latest/?badge=latest
+   :alt: Readthedocs
+
+.. image:: https://img.shields.io/pypi/v/stria.svg
+   :target: https://pypi.org/project/stria
+   :alt: PyPI
+
+*a fast Python package for identification and analysis of short tandem repeat sequences*
+
+Introduction
+============
+
+A Tandem repeat (TR) in genomic sequence is a set of adjacent short DNA sequence repeated consecutively.
+The core sequence or repeat unit is generally called motif. According to the motif length, tandem repeats
+can be classified as microsatellites and minisatellites. Microsatellites are also known as simple sequence
+repeats (SSRs) or short tandem repeats (STRs) with motif length of 1-6 bp. Minisatellites are also sometimes
+referred to as variable number of tandem repeats (VNTRs) has longer motif length than micorsatellites.
+
+The ``stria`` is a lightweight Python C extension for identification and analysis of short tandem repeats.
+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.
+
+Documentation
+=============
+
+`https://stria.readthedocs.io/ <https://stria.readthedocs.io/>`_