Screenshots #20
Screenshots #20
Conversation
Updated README to have screenshots, reworked instructions and bumped workos-node to the latest version v5.0.0.
README.md
Outdated
| <p align="center"> | ||
| <img alt="Screenshot of hosted UI AuthKit in dark mode" src="https://github.com/workos/authkit/assets/108872335/e6e44a30-3ec6-4385-95bd-07709e20e10a" width="45%"> | ||
| | ||
| <img alt="Screenshot of hosted UI AuthKit in light mode" src="https://github.com/workos/authkit/assets/108872335/08ea6ecb-6749-4b31-89d4-49f59321aff7" width="45%"> |
There was a problem hiding this comment.
What do you think about:
- Lead with a single light mode screenshot so it doesn't feel repetitive
- Limiting the OAuth methods to Google and Microsoft so the screen feels a bit more focused—not sure we should showcase every method we have because it will just keep growing
- I’d consider dropping the WorkOS logo and keep the default black button style so that it doesn’t feel like you are going to have WorkOS branding. We could use a sample logo from https://workos.com/user-management
- Should we show a bit more of the padding on the image so it doesn’t feel as zoom in? I think GitHub displays images up to 800px wide before it starts scaling it
| ``` | ||
| ## Running the example | ||
|
|
||
| 1. Install dependencies with `npm install` or `yarn install` |
There was a problem hiding this comment.
With yarn you can just do yarn without install—although not sure whether we want to mention yarn at all given how popular the alternative package managers have become
There was a problem hiding this comment.
I considered that, but for new developers it might not be obvious enough that these do the same thing.
In terms of alternative package managers, I think yarn and npm are ubiquitous enough to get a mention while the others haven't hit that critical mass yet. Either way I don't think it'll hurt to have both npm and yarn here.
|
This is fine, but I could see the gist of the login panel already. #19 was mostly brought up because I was curious about what your avatar dropdown and profile page/modal looked like.
|
|
Hi! We don't currently have components for those, hence why only those screenshots for now. |
Updated README to have screenshots and reworked instructions slightly. Fixes #19