Docs are very minimal

[andy-maier]

• istr version: 1.0.1
• Python version: N/A
• Operating System: N/A

Description

It is great that the docs are on RTD, but there are several issues with the current docs:

• The Usage chapter does not show any usage after showing how to import the package.
• There should be a reference chapter that shows the class with its methods. It is important to understand which methods exactly have the case insensitive behavior, just in case Python adds one.
• There should be some statement about memory use and performance to be expected.
• From the docs, it does not become clear whether this is for byte strings of for unicode strings.
• There is no clear statement on the docs that this is Python 3 only.

[s0undt3ch]

For sure, they are.
Any help is more than welcomed and greatly appreciated.