docs(readme): refactor, cleanup, & styling

mpromonet / webrtc-streamer

WebRTC streamer for V4L2 capture devices, RTSP sources and Screen Capture

https://webrtcstreamer.agreeabletree-365b9a90.canadacentral.azurecontainerapps.io/?layout=2x2

The Unlicense

2.83k stars 582 forks source link

docs(readme): refactor, cleanup, & styling #545

Closed LeoDog896 closed 1 year ago

LeoDog896 commented 1 year ago

Description

This:

Fixes some typos
Removes the broken Codacy badge & replaces the broken heroku badge
Formats it using deno's code formatter
Adds syntax highlighting to most code blocks
Uses opinionated markdown syntax (preferring # over ==========, - over * for lists) -- this causes less markdown errors and should be preferred.

Motivation and Context

The README, at first glance, can look very confusing. This aims to alleviate some of the pain of that.

Types of changes

[x] Docs change / refactoring

okteto-cloud[bot] commented 1 year ago

Your preview environment mpromonet-webrtc-streamer-pr-545 has been deployed.

Preview environment endpoints are available at:

LeoDog896 commented 1 year ago

P.S: would it be appropriate to find contact info? I can't find an IRC chat, discord, or your email whatsoever, so there's no way to report security vulnerabilities or chat and the like. If you can, please provide some info!

mpromonet commented 1 year ago

Hi,

Thanks for improvement of readme, I will look to that. The heroku is no more used since there is no more freeplan, I am testing azure deployement. Using html in readme.md seems curious for me, what I like in md is that it could pure text and could be visualize with a markdown or not.

To discuss some feature, github is a good way, I add the discussion feature as you suggested.

Best Regards, Michel.