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

Cleanup README #480

Merged
merged 8 commits into from
Apr 18, 2023
Merged

Cleanup README #480

merged 8 commits into from
Apr 18, 2023

Conversation

stv0g
Copy link
Member

@stv0g stv0g commented Mar 11, 2023

No description provided.

@stv0g stv0g requested a review from lherman-cs March 11, 2023 15:01
@codecov
Copy link

codecov bot commented Mar 11, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (30badd8) 58.83% compared to head (bb62f20) 58.83%.

❗ Current head bb62f20 differs from pull request most recent head 449d437. Consider uploading reports for the commit 449d437 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #480   +/-   ##
=======================================
  Coverage   58.83%   58.83%           
=======================================
  Files          62       62           
  Lines        3741     3741           
=======================================
  Hits         2201     2201           
  Misses       1413     1413           
  Partials      127      127           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@stv0g stv0g requested a review from Sean-Der March 16, 2023 08:42
README.md Outdated Show resolved Hide resolved
@stv0g stv0g requested a review from at-wat April 5, 2023 06:28
@@ -19,7 +19,7 @@

`go get -u github.com/pion/mediadevices`

## Usage
### Usage
Copy link
Member

Choose a reason for hiding this comment

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

Hierarchy of the sections are changed to

## Install
### Usage
### More Examples
### Available Media Inputs
### Available Codecs
#### Video Codecs
##### x264
### FAQ
#### Failed to find the best driver that fits the constraints
### Roadmap
### Community
### Contributing
### License

but I don't think these '###' sections are subsections of ## Install

Copy link
Member Author

Choose a reason for hiding this comment

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

Oh, I missed the install section. Thanks. I fixed it now.

All Pion repos are using level-3 sections in the readme as the highest level (###).

@stv0g stv0g requested a review from at-wat April 12, 2023 09:28
@stv0g stv0g merged commit f0f6be7 into pion:master Apr 18, 2023
@stv0g stv0g deleted the cleanup-readme branch April 18, 2023 10:12
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.

2 participants