README needs the bare minimum of documentation

hapijs / boom

HTTP-friendly error objects

Other

2.94k stars 192 forks source link

README needs the bare minimum of documentation #234

Closed Soviut closed 5 years ago

Soviut commented 5 years ago

The README is very spartan and it looks pretty bad when you arrive at the npm page and there's not even a description of the project.

At the bare minimum the README should have the following

What does it do/what problem does it solve
How do you install it from npm (especially now that it's under @hapi/boom)
Example usage
Example result

lock[bot] commented 4 years ago

This thread has been automatically locked due to inactivity. Please open a new issue for related bugs or questions following the new issue template instructions.