readme: add badges
readme: document all methods