doc(readme): fixing type, commenting