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

chore: update feature status in README #281

Merged
merged 1 commit into from
May 2, 2024
Merged

Conversation

giangndm
Copy link
Contributor

@giangndm giangndm commented May 2, 2024

Pull Request

Description

This PR updates the status of some features:

  • Room & Peer: 🚀
  • Whip: 🚀
  • Whep: 🚀
  • Simulcast & Svc: 🚀

Related Issue

If this pull request is related to any issue, please mention it here.

Checklist

  • I have tested the changes locally.
  • I have reviewed the code changes.
  • I have updated the documentation, if necessary.
  • I have added appropriate tests, if applicable.

Screenshots

If applicable, add screenshots to help explain the changes made.

Additional Notes

Add any additional notes or context about the pull request here.

Copy link

coderabbitai bot commented May 2, 2024

Walkthrough

Walkthrough

The recent update involves renaming a key component from "Multi-zones Cluster" to "Cluster Room & Peer" and revising its description in the README.md file. Additionally, the status of various features has been updated to reflect their current development progress, with some features marked as completed and others as discontinued.

Changes

File Changes Summary
README.md - Renamed "Multi-zones Cluster" to "Cluster Room & Peer"
- Updated status for features:
- Multi-zones Cluster, Simulcast & SVC, Whip, Whep to 🚀
- WebRTC-SDK, RTMP, RTMP-Transcode to ❌

Poem

🌟 A Little Code Poem by CodeRabbit 🐇

In the land of code, where the snippets roam,
We've renamed a cluster, given features a home.
🚀 Rockets for progress, crosses for halt,
In README's embrace, revisions exalt.
Hop along, dear coder, with glee and cheer,
For changes bring growth, and the future's near!


Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between e92523f and ae3385b.
Files selected for processing (1)
  • README.md (1 hunks)
Additional Context Used
LanguageTool (80)
README.md (80)

Near line 31: Unpaired symbol: ‘]’ seems to be missing
Context: ...twork architecture, please refer to our [Smart-Routing](https://github.com/8xFF/a...


Near line 36: Possible spelling mistake found.
Context: ... is a demo video of the version used by Bluesea Network) ## Project Status: Refactorin...


Near line 40: Possible spelling mistake found.
Context: ...re media server and network stack with [sans-io-runtime](https://github.com/8xff/sans-io-runtim...


Near line 51: Possible spelling mistake found.
Context: ..., or Kubernetes - Easy to scale: global pubsub network, similar to [Cloudflare interco...


Near line 51: Unpaired symbol: ‘(’ seems to be missing
Context: ...dflare.com/announcing-cloudflare-calls/)) | Feature | Description ...


Near line 53: Possible typo: you repeated a whitespace
Context: ...nnouncing-cloudflare-calls/)) | Feature | Description ...


Near line 53: Possible typo: you repeated a whitespace
Context: .../)) | Feature | Description | Status | | ------------------- | -----...


Near line 55: Possible typo: you repeated a whitespace
Context: ...03](8xFF/rfcs#3) | 🚀 | | Simulcast & SVC | Suppo...


Near line 55: Possible typo: you repeated a whitespace
Context: ...s://github.com/8xFF/rfcs/pull/3) | 🚀 | | Simulcast & SVC | Support WebRTC...


Near line 56: Possible typo: you repeated a whitespace
Context: .../pull/3) | 🚀 | | Simulcast & SVC | Support WebRTC Simulcast (VP8, H264) a...


Near line 56: Possible typo: you repeated a whitespace
Context: ...bRTC Simulcast (VP8, H264) and SVC (VP9) | 🚀 | | Whip | Whip ...


Near line 56: Possible typo: you repeated a whitespace
Context: ...) | 🚀 | | Whip | Whip Protocol ...


Near line 57: Possible typo: you repeated a whitespace
Context: ... | 🚀 | | Whip | Whip Protocol ...


Near line 57: Possible typo: you repeated a whitespace
Context: ... | | Whip | Whip Protocol | 🚀 | | Whep | Whep ...


Near line 57: Possible typo: you repeated a whitespace
Context: ... | 🚀 | | Whep | Whep Protocol ...


Near line 58: Possible spelling mistake found.
Context: ... | 🚀 | | Whep | Whep Protocol ...


Near line 58: Possible typo: you repeated a whitespace
Context: ... | 🚀 | | Whep | Whep Protocol ...


Near line 58: Possible spelling mistake found.
Context: ... | 🚀 | | Whep | Whep Protocol ...


Near line 58: Possible typo: you repeated a whitespace
Context: ... | | Whep | Whep Protocol | 🚀 | | WebRTC-SDK | Webrt...


Near line 58: Possible typo: you repeated a whitespace
Context: ... | 🚀 | | WebRTC-SDK | Webrtc-SDK Pro...


Near line 59: Possible typo: you repeated a whitespace
Context: ... | 🚀 | | WebRTC-SDK | Webrtc-SDK Protocol [RFC-0005](https:/...


Near line 59: Possible spelling mistake found.
Context: ... | 🚀 | | WebRTC-SDK | Webrtc-SDK Protocol [RFC-0005](https://github.com/...


Near line 59: Possible typo: you repeated a whitespace
Context: ...05](8xFF/rfcs#5) | ❌ | | RTMP | RTMP P...


Near line 59: Possible typo: you repeated a whitespace
Context: ...m/8xFF/rfcs/pull/5) | ❌ | | RTMP | RTMP Protocol ...


Near line 60: Possible spelling mistake found.
Context: ...cs/pull/5) | ❌ | | RTMP | RTMP Protocol ...


Near line 60: Possible typo: you repeated a whitespace
Context: ...ull/5) | ❌ | | RTMP | RTMP Protocol ...


Near line 60: Possible typo: you repeated a whitespace
Context: ... | | RTMP | RTMP Protocol | ❌ | | RTMP-Transcode | RTMP w...


Near line 60: Possible typo: you repeated a whitespace
Context: ... | ❌ | | RTMP-Transcode | RTMP with Tran...


Near line 61: Possible spelling mistake found.
Context: ... | ❌ | | RTMP-Transcode | RTMP with Transcode ...


Near line 61: Possible typo: you repeated a whitespace
Context: ... | ❌ | | RTMP-Transcode | RTMP with Transcode ...


Near line 61: Possible typo: you repeated a whitespace
Context: ...TMP-Transcode | RTMP with Transcode | ❌ | | SIP | SIP ca...


Near line 61: Possible typo: you repeated a whitespace
Context: ... | ❌ | | SIP | SIP calls ...


Near line 62: Possible typo: you repeated a whitespace
Context: ... | ❌ | | SIP | SIP calls ...


Near line 62: Possible typo: you repeated a whitespace
Context: ... | | SIP | SIP calls | ❌ | | MoQ | Media-...


Near line 62: Possible typo: you repeated a whitespace
Context: ... | ❌ | | MoQ | Media-over-Qui...


Near line 63: Possible spelling mistake found.
Context: ... | ❌ | | MoQ | Media-over-Quic ...


Near line 63: Possible typo: you repeated a whitespace
Context: ... | ❌ | | MoQ | Media-over-Quic ...


Near line 63: Possible spelling mistake found.
Context: ... | ❌ | | MoQ | Media-over-Quic ...


Near line 63: Possible typo: you repeated a whitespace
Context: ... | MoQ | Media-over-Quic | ❌ | | Monitoring | Dashbo...


Near line 63: Possible typo: you repeated a whitespace
Context: ... | ❌ | | Monitoring | Dashboard for ...


Near line 64: Possible typo: you repeated a whitespace
Context: ... | ❌ | | Monitoring | Dashboard for monitoring ...


Near line 64: Possible typo: you repeated a whitespace
Context: ...ring | Dashboard for monitoring | ❌ | | Recording | Record...


Near line 64: Possible typo: you repeated a whitespace
Context: ... | ❌ | | Recording | Record stream ...


Near line 65: Possible typo: you repeated a whitespace
Context: ... | ❌ | | Recording | Record stream ...


Near line 65: Possible typo: you repeated a whitespace
Context: ... | | Recording | Record stream | ❌ | | Gateway | Extern...


Near line 65: Possible typo: you repeated a whitespace
Context: ... | ❌ | | Gateway | External gatew...


Near line 66: Possible typo: you repeated a whitespace
Context: ... | ❌ | | Gateway | External gateway [RFC-0003](https://gi...


Near line 66: Possible typo: you repeated a whitespace
Context: ...03](8xFF/rfcs#3) | ❌ | | Connector | Extern...


Near line 66: Possible typo: you repeated a whitespace
Context: ...xFF/rfcs/pull/3) | ❌ | | Connector | External event...


Near line 67: Possible typo: you repeated a whitespace
Context: ... | ❌ | | Connector | External event handling ...


Near line 67: Possible typo: you repeated a whitespace
Context: ...ctor | External event handling | ❌ | Status: - ❌: Not started - ?...


Near line 67: Possible typo: you repeated a whitespace
Context: ... | ❌ | Status: - ❌: Not started - 🚧: In pr...


Near line 88: Possible typo: you repeated a whitespace
Context: ...er --help ``` - Download prebuild | OS | Arch | Link ...


Near line 88: Possible typo: you repeated a whitespace
Context: ...``` - Download prebuild | OS | Arch | Link ...


Near line 88: Possible typo: you repeated a whitespace
Context: ... prebuild | OS | Arch | Link | | ----- | ------------ | -------------...


Near line 90: The operating system from Apple is written “macOS”.
Context: ...----------------------------------- | | MacOS | aarch64 | [Download](https://git...


Near line 90: Possible typo: you repeated a whitespace
Context: ...-------------------- | | MacOS | aarch64 | [Download](https://github.com/8xFF/atm...


Near line 90: Possible typo: you repeated a whitespace
Context: ...atm0s-media-server-aarch64-apple-darwin) | | MacOS | x86_64 | [Download](ht...


Near line 91: The operating system from Apple is written “macOS”.
Context: ...-server-aarch64-apple-darwin) | | MacOS | x86_64 | [Download](https://git...


Near line 91: Possible typo: you repeated a whitespace
Context: ...4-apple-darwin) | | MacOS | x86_64 | [Download](https://github.com/8xFF/atm...


Near line 91: Possible typo: you repeated a whitespace
Context: .../atm0s-media-server-x86_64-apple-darwin) | | Linux | aarch64 gnu | [Download](ht...


Near line 92: Please check whether ‘knew’ (past of ‘know’) might be the correct word here instead of ‘gnu’ (large African antelope).
Context: ...pple-darwin) | | Linux | aarch64 gnu | [Download](https://github.com/8xFF/a...


Near line 92: Possible typo: you repeated a whitespace
Context: ...e-darwin) | | Linux | aarch64 gnu | [Download](https://github.com/8xFF/atm...


Near line 92: Possible typo: you repeated a whitespace
Context: ...-media-server-aarch64-unknown-linux-gnu) | | Linux | x86_64 gnu | [Download](ht...


Near line 93: Please check whether ‘knew’ (past of ‘know’) might be the correct word here instead of ‘gnu’ (large African antelope).
Context: ...-unknown-linux-gnu) | | Linux | x86_64 gnu | [Download](https://github.com/8xFF/...


Near line 93: Possible typo: you repeated a whitespace
Context: ...known-linux-gnu) | | Linux | x86_64 gnu | [Download](https://github.com/8xFF/atm...


Near line 93: Possible typo: you repeated a whitespace
Context: ...s-media-server-x86_64-unknown-linux-gnu) | | Linux | aarch64 musl | [Download](ht...


Near line 94: Possible spelling mistake found.
Context: ...nknown-linux-gnu) | | Linux | aarch64 musl | [Download](https://github.com/8xFF/at...


Near line 95: Possible spelling mistake found.
Context: ...-unknown-linux-musl) | | Linux | x86_64 musl | [Download](https://github.com/8xFF/a...


Near line 95: Possible typo: you repeated a whitespace
Context: ...nown-linux-musl) | | Linux | x86_64 musl | [Download](https://github.com/8xFF/atm...


Near line 95: Possible typo: you repeated a whitespace
Context: ...-media-server-x86_64-unknown-linux-musl) | - Build from source ``` cargo build ...


Near line 112: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...-zone-index=101 webrtc ``` After node1 started it will print out the node address like...


Near line 112: A comma might be missing here.
Context: ...dex=101 webrtc ``` After node1 started it will print out the node address like `1...


Near line 112: Possible spelling mistake found.
Context: ...it will print out the node address like 101@/ip4/192.168.1.10/udp/10101/ip4/192.168.1.10/tcp/10101, you ...


Near line 126: Possible spelling mistake found.
Context: ...02/samples/whep/whep.html You can use [Pregenerated-Token](./docs/getting-started/quick-start/whi...


Near line 130: You might be missing the article “an” here.
Context: ...gs/demo-screen.jpg) Each node also has embedded monitoring page at `http://localhost:30...


Near line 145: Consider a different adverb to strengthen your wording.
Context: ...usly being improved and updated. We are always looking for ways to make it better, whe...


Near line 145: Consider using a shorter alternative to avoid wordiness.
Context: ...ated. We are always looking for ways to make it better, whether that's through optimizing perf...


Near line 145: Consider a different adverb to strengthen your wording.
Context: ...ontributions from the community and are always looking for new ideas and suggestions. ...


Near line 147: Unpaired symbol: ‘]’ seems to be missing
Context: ...ntributor-guide/README.md) and join our [Discord channel](https://discord.gg/qXr5...

Additional comments not posted (1)
README.md (1)

Line range hint 92-93: Skip this comment as it's a false positive.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@giangndm giangndm marked this pull request as ready for review May 2, 2024 17:22
@giangndm giangndm closed this May 2, 2024
@giangndm giangndm reopened this May 2, 2024
@giangndm giangndm merged commit 5855b17 into master May 2, 2024
19 of 20 checks passed
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Out of diff range and nitpick comments (3)
README.md (3)

Line range hint 31-31: Ensure the markdown link is correctly formatted.

- [Smart-Routing](https://github.com/8xFF/atm0s-sdn/blob/master/docs/smart_routing.md)
+ [Smart-Routing](https://github.com/8xFF/atm0s-sdn/blob/master/docs/smart_routing.md)

Line range hint 90-91: Correct the operating system naming to "macOS".

- MacOS
+ macOS

Line range hint 112-112: Improve the sentence structure for clarity.

- After node1 started it will print out the node address like
+ After node1 starts, it will print out the node address like

@giangndm giangndm deleted the chore-update-readme branch June 20, 2024 11:02
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

1 participant