Skip to content

Commit

Permalink
add better start page in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
maxbachmann committed Dec 11, 2022
1 parent 08c1ecc commit 607cd73
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 2 deletions.
2 changes: 2 additions & 0 deletions docs/License.rst
@@ -1,3 +1,5 @@
.. _my-license-label:

License
=======

Expand Down
33 changes: 31 additions & 2 deletions docs/index.rst
@@ -1,5 +1,32 @@
RapidFuzz
=========
|header-image|
=================

RapidFuzz performs fuzzy string matching between two or more sequences using various string metrics.

Fundamental algorithms
----------------------
RapidFuzz provides a wide range of fundamental algorithms for string matching.
In addition it provides an API compatible implementation of all algorithms in ``thefuzz`` \/ ``fuzzywuzzy``.

Performant
----------
Rapidfuzz wraps highly-optimized implementations written in C++.
Enjoy the flexibility of Python with the speed of compiled code.

Easy to use
-----------
RapidFuzz's high level syntax makes it accessible and productive for programmers
from any background or experience level.

Compatible
----------
RapidFuzz provides a pure python fallback for every algorithm. This ensures that the library works on platforms
where compiling a C extension is not possible.

Open source
-----------
Distributed under a :ref:`MIT License <my-license-label>`, RapidFuzz is developed and maintained `publicly on GitHub <https://github.com/maxbachmann/RapidFuzz>`_.


.. toctree::
:hidden:
Expand All @@ -16,3 +43,5 @@ RapidFuzz
License
References
GitHub Repository <https://github.com/maxbachmann/RapidFuzz>

.. |header-image| image:: img/RapidFuzz.svg

0 comments on commit 607cd73

Please sign in to comment.