Skip to content

Commit

Permalink
Documentation fix
Browse files Browse the repository at this point in the history
  • Loading branch information
thelabcat committed Dec 28, 2024
1 parent 8f93237 commit 9849d0d
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 5 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,8 @@ import rumchat_actor
#Then, instantiate the Actor object.
#stream_id is either the base 10 or base 36 livestream ID you want the Actor to connect to, obtained from the popout chat or the Rumble Live Stream API.
#If stream_id is None but you pass api_url, the latest livestream shown on the API is chosen automatically.
#If you pass profile_dir to an existing Firefox profile directory, your sign-ins to Rumble chat for the actor will be saved.
#Otherwise, you will have to log in manuaglly each time you use the bot, or pass username and password.
actor = rumchat_actor.RumbleChatActor(stream_id = STREAM_ID)
#If you do not pass password, it will be requested
actor = rumchat_actor.RumbleChatActor(stream_id = STREAM_ID, username = USERNAME, password = PASSWORD)
#Let's set up a message action. A message action is a function called on every chat message.
#It is passed the cocorum.ssechat.SSEChatMessage object, and the RumbleChatActor object.
Expand Down
4 changes: 2 additions & 2 deletions src/rumchat_actor/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ def eat_some_cheese(message, actor):
#stream_id is either the base 10 or base 36 livestream ID you want the Actor to connect to, obtained from the popout chat or the Rumble Live Stream API.
#If stream_id is None but you pass api_url, the latest livestream shown on the API is chosen automatically.
#Pass CREDENTIALS to log in to Rumble
actor = rumchat_actor.RumbleChatActor(stream_id = STREAM_ID, username, password = CREDENTIALS)
#If you do not pass password, it will be requested
actor = rumchat_actor.RumbleChatActor(stream_id = STREAM_ID, username = USERNAME, password = PASSWORD)
#Register an action to be called on every message
actor.register_message_action(eat_some_cheese)
Expand Down

0 comments on commit 9849d0d

Please sign in to comment.