search

hapijs / hapi-pino

🌲 Hapi plugin for the Pino logger
MIT License
148 stars 61 forks source link

docs: improve API docs in README; add types, improve formatting #89

Closed BlooJeans closed 5 years ago

BlooJeans commented 5 years ago

Updates the docs to be a little more structured + have typedefs included for those so inclined Also brings it closer in parity to pino's docs ( https://github.com/pinojs/pino/blob/master/docs/api.md#pinooptions-destination--logger )

Before: Screenshot_20191028_143322

After: Screenshot_20191028_143255

coveralls commented 5 years ago

Coverage Status

Coverage remained the same at 99.018% when pulling 8f26957d17b85b26796c0263f24048e2b1e69bc5 on devshackio:readme-improve-api-docs into 02ce38b6d4a6107071ca4d223e685e9764a99422 on pinojs:master.