Skip to content

Commit ce4e3a6

Browse files
committed
Change some wording and add links to index and README
1 parent ad4540f commit ce4e3a6

File tree

2 files changed

+22
-31
lines changed

2 files changed

+22
-31
lines changed

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,21 @@
1-
> [!IMPORTANT]
2-
> Version **3** is currently a BETA release.
3-
41
![](https://raw.githubusercontent.com/TwitchIO/TwitchIO/main/logo.png)
52
[![](https://img.shields.io/badge/Python-3.11%20%7C%203.12%20%7C%203.13-blue.svg)](https://www.python.org)
63
![Pyright Strict](https://img.shields.io/badge/Pyright-Strict-b8dbb4)
74
![GitHub License](https://img.shields.io/github/license/PythonistaGuild/twitchio)
85

9-
A powerful async Python library for the twitch API and EventSub. Fully featured, modern Object-Orientated design
10-
with stateful objects.
6+
A fully featured, powerful async Python library for the Twitch API and EventSub with modern Object-Orientated design
7+
and stateful objects.
118

12-
TwitchIO provides ease of use when accessing the Twitch API with powerful extensions and hot-reloadable modules to help create
13-
and manage applications on twitch.
9+
TwitchIO provides ease of use when accessing the Twitch API with powerful extensions for chat commands, web-frameworks and overlays
10+
with hot-reloadable modules to help create and manage bots, backends, websites and other applications on Twitch.
1411

1512
**Features:**
1613

1714
- Modern ``async`` Python using ``asyncio``
1815
- Fully annotated and complies with the ``pyright`` strict type-checker
1916
- Intuitive with ease of use, using modern object orientated design
2017
- Conduit support for scaling and EventSub continuity
21-
- Feature full including extensions for ``chat bots``, running ``routine tasks`` and ``playing sounds`` on stream
18+
- Feature full including extensions for ``chat bots``, running ``routine tasks`` and ``overlays`` on stream
2219
- Easily manage ``OAuth Tokens`` and data
2320
- Built-in ``EventSub`` support via ``Webhook``, ``Websockets`` and ``Conduits``.
2421

@@ -33,8 +30,15 @@ Getting Started
3330

3431
[Examples](/examples)
3532

33+
Useful Links
34+
--------------
35+
[Scope/OAuth URL Generator](https://chillymosh.com/tools/twitch-scopes/)
36+
37+
[Twitch API Documentation](https://dev.twitch.tv/docs/)
38+
39+
[Twitch Developer Console](https://dev.twitch.tv/console)
40+
3641
### Support
3742
For support using TwitchIO, please join the official [support server](https://discord.gg/RAKc3HF) on [Discord](https://discord.com/)
3843

3944
[![Discord Banner](https://discordapp.com/api/guilds/490948346773635102/widget.png?style=banner2)](https://discord.gg/RAKc3HF)
40-

docs/index.rst

Lines changed: 9 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,33 +6,25 @@
66
TwitchIO
77
#########
88

9-
.. warning::
10-
11-
This is a beta release. Please take care using this release in production ready applications.
12-
13-
14-
.. important::
15-
16-
This documentation is for **Version 3**. For **Version 2.10** see: `2.10 Docs <https://twitchio.dev/en/historical-2.10.0/>`_.
17-
18-
19-
TwitchIO is a powerful async Python library for the twitch API and EventSub. Fully featured, modern Object-Orientated design
20-
with stateful objects.
21-
22-
TwitchIO provides ease of use when accessing the Twitch API with powerful extensions and hot-reloadable modules to help create
23-
and manage applications on twitch. TwitchIO is inspired by `discord.py <https://github.com/Rapptz/discord.py>`_.
9+
A fully featured, powerful async Python library for the Twitch API and EventSub with modern Object-Orientated design
10+
and stateful objects.
2411

12+
TwitchIO provides ease of use when accessing the Twitch API with powerful extensions for chat commands, web-frameworks and overlays
13+
with hot-reloadable modules to help create and manage bots, backends, websites and other applications on Twitch.
2514

2615
**Features:**
2716

2817
- Modern ``async`` Python using ``asyncio``
2918
- Fully annotated and complies with the ``pyright`` strict type-checker
3019
- Intuitive with ease of use, using modern object orientated design
3120
- Conduit support for scaling and EventSub continuity
32-
- Feature full including extensions for ``chat bots``, running ``routine tasks`` and ``playing sounds`` on stream
21+
- Feature full including extensions for ``chat bots``, running ``routine tasks`` and ``overlays`` on stream
3322
- Easily manage ``OAuth Tokens`` and data
3423
- Built-in ``EventSub`` support via ``Webhook``, ``Websockets`` and :ref:`Conduits<Conduit Ref>`.
3524

25+
TwitchIO is a powerful async Python library for the twitch API and EventSub. Fully featured, modern Object-Orientated design
26+
with stateful objects. TwitchIO is inspired by `discord.py <https://github.com/Rapptz/discord.py>`_.
27+
3628

3729
Help and support
3830
----------------
@@ -42,11 +34,6 @@ Help and support
4234
- Visit our `Discord <https://discord.gg/RAKc3HF>`_ for help using TwitchIO
4335

4436

45-
.. warning::
46-
47-
This document is a work in progress.
48-
49-
5037
Getting Started
5138
---------------
5239

@@ -83,7 +70,7 @@ References
8370

8471
exts/commands/index
8572
exts/routines/index
86-
exts/sounds/index
73+
exts/overlays/index
8774

8875
.. toctree::
8976
:maxdepth: 1

0 commit comments

Comments
 (0)