-
Notifications
You must be signed in to change notification settings - Fork 18
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
Update README.md #35
Update README.md #35
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
@@ -84,7 +84,18 @@ namespace TwitchLib.EventSub.Websockets.Test | |||
|
|||
if (!e.IsRequestedReconnect) | |||
{ | |||
// subscribe to topics | |||
/* | |||
Subscribe to topics via the TwitchApi.Helix.EventSub object, this example shows how to subscribe to the channel follow event used in the example above. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would add for full transparency that twitchlib.api needs to be installed to access this class of objects.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are you/someone else able to add that as I dont know what your expected release/consumption model is for this library, I just include the TwitchLib
nuget library which contains all of them. So you would probably be in a better position to recommend how you want people to consume the library to use with this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I usually don't use the suite myself since I like to streamline. But this would help with confusion for people that use individual repos and not have API already installed.
Basically say Prerequisite = Twitchlib.api (included in the Twitchlib package automatically)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added what you asked, let me know if you want any other alterations.
Having tried to use this library I found the documentation was unclear on how you were supposed to subscribe for the EventSub part of TwitchLib to work.
After discussing in the discord I said I would add to the documentation to make it clearer to others how it should be done, others may already know this, but for muggles like me I think it would be helpful.