Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Update README with highlights and getting started guide #627

Merged
merged 3 commits into from
Mar 28, 2022

Conversation

kylecarbs
Copy link
Member

No description provided.

@codecov
Copy link

codecov bot commented Mar 28, 2022

Codecov Report

Merging #627 (aadf806) into main (13cef7d) will decrease coverage by 0.07%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #627      +/-   ##
==========================================
- Coverage   63.65%   63.57%   -0.08%     
==========================================
  Files         197      197              
  Lines       11537    11537              
  Branches       85       85              
==========================================
- Hits         7344     7335       -9     
- Misses       3416     3423       +7     
- Partials      777      779       +2     
Flag Coverage Δ
unittest-go- 62.56% <ø> (-0.13%) ⬇️
unittest-go-macos-latest 58.47% <ø> (ø)
unittest-go-ubuntu-latest 61.60% <ø> (+0.09%) ⬆️
unittest-go-windows-2022 57.65% <ø> (+0.04%) ⬆️
unittest-js 63.32% <ø> (ø)
Impacted Files Coverage Δ
peerbroker/dial.go 75.43% <0.00%> (-7.02%) ⬇️
coderd/workspaceresources.go 59.72% <0.00%> (-1.81%) ⬇️
provisionerd/provisionerd.go 80.02% <0.00%> (-0.59%) ⬇️
coderd/provisionerdaemons.go 59.73% <0.00%> (-0.51%) ⬇️
peer/conn.go 78.93% <0.00%> (+0.76%) ⬆️
provisionersdk/serve.go 43.24% <0.00%> (+8.10%) ⬆️

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 13cef7d...aadf806. Read the comment docs.

Comment on lines +9 to +11
- Automate development environments for Linux, Windows, and MacOS in your cloud
- Start writing code with a single command
- Use one of many [examples](./examples) to get started
Copy link
Member

@bpmct bpmct Mar 28, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was gonna nit on the messaging a bit, but decided it'd be more productive once we create a messaging doc. I like the placement of these here 👍🏼

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, we can totally change these whenever. Feel free to nit on em' now if you'd like. I'm all ears!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can make these a lot more compelling but I'll wait to invest until Ben takes a pass.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
@kylecarbs kylecarbs requested review from ammario and bpmct March 28, 2022 20:03
Copy link
Member

@ammario ammario left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good first iteration

@kylecarbs kylecarbs merged commit e0172dd into main Mar 28, 2022
@kylecarbs kylecarbs deleted the contributing branch March 28, 2022 20:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants