Everyone here is saying to give lots of examples: I would add to not ONLY give examples, but also make sure you explain parameters, return types, etc.
The most frustrating type of documentation for me is when there are usage examples but nothing else. Then, when I invariably want to use the library in a way that's slightly different than the provided example, there's no documentation available.
The most frustrating type of documentation for me is when there are usage examples but nothing else. Then, when I invariably want to use the library in a way that's slightly different than the provided example, there's no documentation available.