PAS-438 | Touch up the readme with more information

[Tyrrrz]

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 32.90%. Comparing base (a2ea77a) to head (31d57a4). Report is 22 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #569      +/-   ##
==========================================
+ Coverage   32.56%   32.90%   +0.33%     
==========================================
  Files         525      518       -7     
  Lines       26533    26189     -344     
  Branches      858      774      -84     
==========================================
- Hits         8640     8617      -23     
+ Misses      17774    17448     -326     
- Partials      119      124       +5     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

[Tyrrrz]

@abergs @jonashendrickx any comments? 🙂

[abergs]

@Tyrrrz Could we perhaps include a link to our demo or a gif on the UX? I think it's powerful.

[Tyrrrz]

@Tyrrrz Could we perhaps include a link to our demo or a gif on the UX? I think it's powerful.

Do we have such a demo/gif already?

[Tyrrrz]

@abergs I added the demo video. There were two options on how to embed it into the readme:

1. GIF. This is the most straight-forward option and supports auto-play. However, the file size is quite big -- 11mb. I can sacrifice the quality or the framerate to compress it, but then it looks quite ugly.
2. Video element. It doesn't support auto-play. But it allows us to embed an actual video file, namely webm in this case, which is only 800kb in size without any loss in quality. The file is also not part of the repository but instead hosted by GitHub, so it won't affect cloning.

I went with option 2. This is what it looks like: https://github.com/bitwarden/passwordless-server/tree/Tyrrrz-patch-1?tab=readme-ov-file#demo

As a side note, I was able to record the Windows Hello popup without issues, so the user can see the whole authentication process.

Let me know if this is good enough.

[abergs]

Solid! @Tyrrrz