diff --git a/README.rst b/README.rst index ade4ff2..75569e4 100644 --- a/README.rst +++ b/README.rst @@ -2,28 +2,28 @@ srt is a tiny Python library for parsing, modifying, and composing `SRT files`_. Take a look at the quickstart_ for a basic overview of the library. `Detailed API documentation`_ is also available. -Why choose this library? Well, it's: - -- Very fast (shifting the time on 50 2-hour SRT subtitles takes around 2 - seconds on a fairly recent machine); -- All functionality is covered with tests; -- Well documented API, without being overly verbose; -- Able to parse many not-totally-legal SRT files without sacrificing - performance (for example, SRT files with blank lines in the content, and - proprietary metadata after the timestamps); -- Completely Unicode compliant both on Python 2 and 3; -- Small (excluding docstrings/blank lines/etc, only a little more than 100 - lines of code); -- Complete without feature creep -- currently used in production every day on - real-world SRT files. - -Want to see some real-world examples of its use? Take a look at the srt-tools_ -repo. +Want to see some examples of its use? Take a look at the srt-tools_ repo. + +Why choose this library? +------------------------ + +- Extremely lightweight, excluding docstrings/comments/etc around 200 SLOC +- High quality test suite using Hypothesis_ +- `100% test coverage`_ (including branches) +- `Well documented API`_, at both a high and low level +- Tolerant of many common errors found in real-world SRT files +- Completely Unicode compliant +- Real world tested — used in production to process thousands of SRT files + every day + .. _quickstart: http://srt.readthedocs.org/en/latest/quickstart.html .. _`Detailed API documentation`: http://srt.readthedocs.org/en/latest/api.html .. _srt-tools: https://github.com/cdown/srt-tools .. _`SRT files`: https://en.wikipedia.org/wiki/SubRip#SubRip_text_file_format +.. _Hypothesis: https://github.com/DRMacIver/hypothesis +.. _`100% test coverage`: https://coveralls.io/github/cdown/srt?branch=develop +.. _`Well documented API`: http://srt.readthedocs.org/en/latest/index.html Installation ------------