There are two things I look for whenever I check out an Opensource project or library that I want to use.
Screenshots (A picture is worth a thousand words).
Examples (Don’t tell me what to do, show me how to do it).
Having a fully working example (or many examples) helps me shape my thought process.
Here are a few projects that are excellent examples of this.
A CLI framework for building rich command line interfaces. The project comes with a collection of small self-sufficient examples that showcase every feature available in the framework and a nice little tutorial.
A small ORM for Python that ships with multiple web projects to showcase how to use the ORM effectively. I’m always overwhelmed by SqlAlchemy’s documentation site. PeeWee is a breath of fresh air with a clear purpose and succinct documentation.
An asynchronous task queue for Python that is simpler than Celery and more featureful than RQ. This project also ships with an awesome set of examples that show how to integrate the task queue with Django, Flask or standalone use case.
The beauty of these examples is that they’re self-documenting and show us how the different pieces in the library work with each other as well as external code outside of their library such as Flask, Django, Asyncio etc.
Examples save the users hours of sifting through documentation to piece together how to use a library.
Please include examples in your project.