Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
otothea committed Jul 23, 2020
1 parent 76c8172 commit c9f9f51
Show file tree
Hide file tree
Showing 8 changed files with 17 additions and 17 deletions.
2 changes: 1 addition & 1 deletion docs/commands/default/amazon.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

**Default Permission:** Everyone

Search Amazon products. Returns top 10 results in Discord and top result in Twitch, Mixer, & YouTube.
Search Amazon products. Returns top 10 results in Discord and top result in Twitch, YouTube, & Facebook.

Usage:
!amazon ``<search>``
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/default/command.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ __ #reset

.. note::

Commands are enabled and disabled based on the platform (Twitch, Mixer, YouTube, etc.) the command was issued from. Commands will respond to the channel they are called from.
Commands are enabled and disabled based on the platform (Twitch, YouTube, Facebook, etc.) the command was issued from. Commands will respond to the channel they are called from.

delete
^^^^^^
Expand Down
20 changes: 10 additions & 10 deletions docs/commands/default/link.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

**Default Permission:** Everyone

The ``!link`` command is used to link users from different platforms together to share currency and XP. Each group of linked users can have 1 user from each platform linked (Twitch, Mixer, YouTube, and Discord). You must have login access to the user account on each platform to be able to link them.
The ``!link`` command is used to link users from different platforms together to share currency and XP. Each group of linked users can have 1 user from each platform linked (Twitch, YouTube, Facebook, and Discord). You must have login access to the user account on each platform to be able to link them.

- `Link Users`_
- `Check Linked Users`_
Expand All @@ -14,37 +14,37 @@ Link Users

Log in to a chat platform (in this example we'll use Twitch) and join the channel with Botisimo and initiate the linking process by targeting another platform and username::

(twitch) Player1: !link mixer Player1
(twitch) Player1: !link youtube Player1

If the targeted user is not in the system, you may need to log in and send a message in chat to allow Botisimo to register that user to the system. If the user is in the system, Botisimo will respond with instructions to complete the link::

(twitch) Botisimo: Link initiated. Please log in to mixer as Player1 and type "!link twitch Player1" to finish linking with Player1 [twitch]
(twitch) Botisimo: Link initiated. Please log in to youtube as Player1 and type "!link twitch Player1" to finish linking with Player1 [twitch]

Log in to the your user on the other platform (in this example we are using Mixer) and complete the link::
Log in to the your user on the other platform (in this example we are using YouTube) and complete the link::

(mixer) Player1: !link twitch Player1
(youtube) Player1: !link twitch Player1

If everything is correct, Botisimo will let you know your users have been linked::

(mixer) Botisimo: Player1 [mixer] has been linked with Player1 [twitch]
(youtube) Botisimo: Player1 [youtube] has been linked with Player1 [twitch]

That's it! To link another user you would just repeat the steps::

(twitch) Player1: !link discord Player1
(twitch) Botisimo: Link initiated. Please log in to discord as Player1 and type "!link twitch Player1" to finish linking with Player1 [twitch], Player1 [mixer]
(twitch) Botisimo: Link initiated. Please log in to discord as Player1 and type "!link twitch Player1" to finish linking with Player1 [twitch], Player1 [youtube]

::

(discord) Player1: !link twitch Player1
(discord) Botisimo: Player1 [discord] has been linked with Player1 [twitch], Player1 [mixer]
(discord) Botisimo: Player1 [discord] has been linked with Player1 [twitch], Player1 [youtube]

Check Linked Users
^^^^^^^^^^^^^^^^^^

You can use ``!link`` to see what users are linked together::

(twitch) Player1: !link
(twitch) Botisimo: Player1 [twitch], Player1 [mixer], Player1 [discord]
(twitch) Botisimo: Player1 [twitch], Player1 [youtube], Player1 [discord]

Unlink Users
^^^^^^^^^^^^
Expand All @@ -54,4 +54,4 @@ To unlink a user you can target a platform with the ``!unlink`` command::
(twitch) Player1: !unlink discord
(twitch) Botisimo: Player1 [discord] has been unlinked
(twitch) Player1: !link
(twitch) Botisimo: Player1 [twitch], Player1 [mixer]
(twitch) Botisimo: Player1 [twitch], Player1 [youtube]
2 changes: 1 addition & 1 deletion docs/commands/default/reddit.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

**Default Permission:** Everyone

Get the latest post(s) for a subreddit. Returns top 10 results in Discord and top result in Twitch & Mixer.
Get the latest post(s) for a subreddit. Returns top 10 results in Discord and top result in Twitch, YouTube, & Facebook.

Usage:
!reddit ``<subreddit>``
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/default/stackoverflow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

**Default Permission:** Everyone

Search Stackoverflow questions. Returns top 10 results in Discord and top result in Twitch & Mixer.
Search Stackoverflow questions. Returns top 10 results in Discord and top result in Twitch, YouTube, & Facebook.

Usage:
!stackoverflow ``<search>``
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/default/timer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ __ #stop

.. note::

Timers are started and stopped based on the platform (Twitch, Mixer, YouTube, etc.) the command was issued from. Timers will only post to a single channel per platform.
Timers are started and stopped based on the platform (Twitch, YouTube, Facebook, etc.) the command was issued from. Timers will only post to a single channel per platform.

.. note::

Expand Down
2 changes: 1 addition & 1 deletion docs/commands/default/wikipedia.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

**Default Permission:** Everyone

Search Wikipedia topics. Returns top 10 results in Discord and top result in Twitch & Mixer.
Search Wikipedia topics. Returns top 10 results in Discord and top result in Twitch, YouTube, & Facebook.

Usage:
!wikipedia ``<search>``
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Welcome!
What is Botisimo?
^^^^^^^^^^^^^^^^^

Botisimo is a cross-platform chat bot & viewer engagement tools as a service for Twitch, Mixer, YouTube, & Discord. Botisimo provides viewer loyalty tracking, custom commands, polls, chat logs, stream overlays, and more.
Botisimo is a cross-platform chat bot & viewer engagement tools. Botisimo supports leading stream and chat platforms such as Twitch, Youtube, Facebook and Discord. Botisimo provides analytics for your chats as well as user tracking, custom commands, timers, polls, chat logs, stream overlays, song requests, and more.

`Learn More at Botisimo.com → <https://botisimo.com>`_

Expand Down

0 comments on commit c9f9f51

Please sign in to comment.