search

phoenixframework / phoenix_live_reload

Provides live-reload functionality for Phoenix
MIT License
315 stars 90 forks source link

Add README.md and CHANGELOG.md to the docs #168

Closed smaximov closed 2 weeks ago

smaximov commented 2 weeks ago

I've been upgrading my app, and as part of the upgrade I bumped phoenix_live_reload to the latest version (v1.5.3). In the change log I found a mention of :web_console_logger.

The docs for :web_console_logger refer to README.md for instructions on how to setup streaming server logs to the web console, but README.md is not included in the docs, so I had to leave Hexdocs and go to Github to read the instructions.

In this PR I've added README.md and CHANGELOG.md to the docs, I've also made README.md the entry point of the docs (instead of the "API Reference" page).

josevalim commented 2 weeks ago

:green_heart: :blue_heart: :purple_heart: :yellow_heart: :heart: