Changed command order in help and README. Improved README text.
This commit is contained in:
parent
f583af7e4f
commit
09a59717be
|
@ -1,18 +1,22 @@
|
||||||
|
![Woodpecker-CI](https://drone.sarkasti.eu/api/badges/lomion/tmdb-bot/status.svg)
|
||||||
# tmdb-bot
|
# tmdb-bot
|
||||||
A [maubot](https://github.com/maubot/maubot) to get information about movies from [TheMovieDB.org](https://www.themoviedb.org/).
|
A [maubot](https://github.com/maubot/maubot) for Matrix messaging to get information about movies from [TheMovieDB.org](https://www.themoviedb.org/).
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
Use `!tmdb help` to get help about the bot usage.
|
Use `!tmdb help` to get help about the bot usage.
|
||||||
|
|
||||||
Use `!tmdb movie {title} [y:{release year}]` to get movie detail based on the given title.
|
Use `!tmdb movie {title} [y:{release year}]` to get movie detail based on the given title.
|
||||||
|
|
||||||
|
Use `!tmdb tvshow {title}` to get detail about a tv show based on the given title.
|
||||||
|
|
||||||
Use `!tmdb popular [{rating}]` to get most popular movies. Get details about any one movie in the list by adding the {rating}.
|
Use `!tmdb popular [{rating}]` to get most popular movies. Get details about any one movie in the list by adding the {rating}.
|
||||||
|
|
||||||
Use `!tmdb language {language}` to set your prefered language.
|
Use `!tmdb language {language}` to set your prefered language.
|
||||||
|
|
||||||
Use `!tmdb poster_size [{size}]` to set your prefered poster size. With empty {size} all available sizes are listed.
|
Use `!tmdb poster_size [{size}]` to set your prefered poster size. With empty {size} all available sizes are listed.
|
||||||
|
|
||||||
Use `!tmdb tvshow {title}` to get detail about a tv show based on the given title.
|
## Screenshot
|
||||||
|
![Screenshot](screenshot_tmdb-bot-1.2.0.jpg)
|
||||||
|
|
||||||
## Discussion
|
## Discussion
|
||||||
Matrix room: [#tmdb-bot:matrix.sarkasti.eu](https://matrix.to/#/#tmdb-bot:matrix.sarkasti.eu)
|
Matrix room: [#tmdb-bot:matrix.sarkasti.eu](https://matrix.to/#/#tmdb-bot:matrix.sarkasti.eu)
|
||||||
|
|
|
@ -74,10 +74,10 @@ class TmdbBot(Plugin):
|
||||||
|
|
||||||
async def send_help(self, evt: MessageEvent) -> None:
|
async def send_help(self, evt: MessageEvent) -> None:
|
||||||
html = """<p>Use <b>!tmdb movie {title} [y:{release year}]</b> to get movie detail based on the given title.</p>
|
html = """<p>Use <b>!tmdb movie {title} [y:{release year}]</b> to get movie detail based on the given title.</p>
|
||||||
|
<p>Use <b>!tmdb tvshow {title}</b> to get detail about a tv show based on the given title.</p>
|
||||||
<p>Use <b>!tmdb popular [{rating}]</b> to get most popular movies. Get details about any one movie in the list by adding the {rating}.</p>
|
<p>Use <b>!tmdb popular [{rating}]</b> to get most popular movies. Get details about any one movie in the list by adding the {rating}.</p>
|
||||||
<p>Use <b>!tmdb language {language}</b> to set your prefered language.</p>
|
<p>Use <b>!tmdb language {language}</b> to set your prefered language.</p>
|
||||||
<p>Use <b>!tmdb poster_size [{size}]</b> to set your prefered poster size. With empty {size} all available sizes are listed.</p>
|
<p>Use <b>!tmdb poster_size [{size}]</b> to set your prefered poster size. With empty {size} all available sizes are listed.</p>"""
|
||||||
<p>Use <b>!tmdb tvshow {title}</b> to get detail about a tv show based on the given title.</p>"""
|
|
||||||
content = TextMessageEventContent(
|
content = TextMessageEventContent(
|
||||||
msgtype=MessageType.TEXT, format=Format.HTML,
|
msgtype=MessageType.TEXT, format=Format.HTML,
|
||||||
body="Help for TMDB Bot",
|
body="Help for TMDB Bot",
|
||||||
|
|
Loading…
Reference in a new issue