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(docs): spruce up readmes #161

Merged
merged 3 commits into from
Feb 11, 2025
Merged

Conversation

joelhooks
Copy link
Contributor

just basics from our chat

Copy link

changeset-bot bot commented Feb 7, 2025

🦋 Changeset detected

Latest commit: 01f304d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 12 packages
Name Type
partyagent Patch
partybase Patch
partyflow Patch
partyfn Patch
partyhard Patch
partysession Patch
partysmart Patch
partysub Patch
partysync Patch
partytracks Patch
partywhen Patch
y-partyserver Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@@ -1,3 +1,21 @@
# partytracks

Audio/video handling for PartyServer apps using Observables for WebRTC.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Hey there 👋🏻 I'm Kevin — nice to meet you! I wrote partytracks, and wanted to share my thoughts!

First, this is awesome — I've been unhappy w/ what I came up with for the README here and this is already way better.

My only concern, and maybe not a big deal to worry about, but partytracks can easily be used outside of PartyServer apps — I wouldn't want someone to read this and think they can't use it if they're not using PartyServer.

From my perspective the one concept people should understand is that with this package you can go from:

MediaStreamTrack => simple, serializable JS object
and
simple, serializable JS object => MediaStreamTrack

And that's all you need to get audio/video data flowing from one user to another. How you shuffle that track metadata from one user to another is on you, and PartyServer is a great way to do it.

Anyway, thanks again — love the changes! 🙏🏻

Copy link
Collaborator

Choose a reason for hiding this comment

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

Also, please don't feel obligated to change anything based on my feedback before merging. Just wanted to jot it down and share!

Copy link
Owner

Choose a reason for hiding this comment

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

removed the word partyserver, easy

@threepointone threepointone merged commit c73b724 into threepointone:main Feb 11, 2025
1 check passed
@threepointone threepointone mentioned this pull request Feb 11, 2025
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.

3 participants