add documentation

i wish to use this to display my grades in a kde applet , and i see that there are internal functions that could provide the functunality i need  , however i also need documentation for how to use them etc