It is probably best if I put it in main README.md of the repo, and I can link to it from the PYPI README.

First entry for the FAQ could be: Martinsos/edlib#138 .

I am having a hard time understanding what all those functions of this library are used for and which one I should use.

It would be good to have a broad explanation of the algorithm, it's uses and maybe a link to some resources, that explains it in further detail. Maybe also list the advantages and disadvantages?

You could also include some real world examples

For example, how could I imp

There is a demo for how to use the library on the README.md, as well as the wiki. The demo is manually maintained, at the moment, which is error prone during refactoring. Update the documentation generator to test the source in the example, before adding it to the documentation.

Codacy detected an issue:

Message: Add a 'default' clause to this 'switch' statement.

Occurred on:

• Commit: 32ba74ca70e14ffc4ee15c5a5b557e9014eda5ca
• File: Core/Encodings/Utf8.cs
• LineNum: