search

ueberauth / guardian_phoenix

A collection of helpers for when using Guardian with Phoenix
MIT License
45 stars 10 forks source link

Add Sockets doc link to README.md #10

Closed WLSF closed 3 years ago

WLSF commented 3 years ago

Hi, I'm not sure if this is a valid contribution, but I'm going to left it here as a suggestion.

I was digging into the repo looking for the documentation and I just realize that for now the only doc available is the @moduledoc from the Socket module (socket.ex).

And the hexdoc link on the README points to a page that states exactly the same thing as the README.

Screen Shot 2021-02-25 at 23 28 17

Perhaps it would be more helpful to point the user to the Socket module hexdoc page.

codecov-io commented 3 years ago

Codecov Report

Merging #10 (566f7f4) into master (604eefd) will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #10   +/-   ##
=======================================
  Coverage   93.33%   93.33%           
=======================================
  Files           1        1           
  Lines          15       15           
=======================================
  Hits           14       14           
  Misses          1        1

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 604eefd...566f7f4. Read the comment docs.