Readme polish - Githubissues

planetscale / beam

A simple message board for your organization or project

https://planetscale.com/blog/introducing-beam

MIT License

2.06k stars 141 forks source link

Readme polish #39

Closed jasonlong closed 2 years ago

jasonlong commented 2 years ago

This is an iteration on the readme to do a few things:

Add the beam logo and a screenshot
Try to streamline the copy and the instructions as much as possible
Add a placeholder spot for the GitHub auth section
Link to okta-specific instructions
Remove changelog - going forward, we'll keep track of these on the releases page

vercel[bot] commented 2 years ago

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/planetscale/beam/GrtFHEJtPQkRLDQZQJqL8y6dBBuY
✅ Preview: https://beam-git-readme-polish.preview.planetscale.com

jasonlong commented 2 years ago

@skottler Would you mind taking a look at the failing license_finder run here? I'm not sure it's complaining about specifically.

Update: Nevermind, turns out license_finder doesn't like the doc directory name to be changed (I had tried to use docs).

vercel[bot] commented 2 years ago

@bogdansoare is attempting to deploy a commit to the PlanetScale Team on Vercel.

To accomplish this, @bogdansoare needs to request access to the Team.

Afterwards, an owner of the Team is required to accept their membership request.

If you're already a member of the respective Vercel Team, make sure that your Personal Vercel Account is connected to your GitHub account.