Skip to content
This repository was archived by the owner on Mar 1, 2022. It is now read-only.

Commit 706e193

Browse files
authored
Update and rename README.md to README.rst
1 parent 7836cf1 commit 706e193

File tree

2 files changed

+64
-2
lines changed

2 files changed

+64
-2
lines changed

README.md

Lines changed: 0 additions & 2 deletions
This file was deleted.

README.rst

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
A simple to use, highly customizable, Interactive Session and Paginator for discord.py.
2+
Still in alpha stages, and rapid production. Feel free to suggest something via Discord.
3+
4+
Support
5+
---------------------------
6+
For support using Buttons, please join the official `support server
7+
<http://discord.gg/JhW28zp>`_ on `Discord <https://discordapp.com/>`_.
8+
9+
Installation
10+
---------------------------
11+
**Buttons requires Python 3.6 or higher.**
12+
13+
**Windows**
14+
15+
.. code:: sh
16+
17+
py -version -m pip install buttons
18+
19+
**Linux**
20+
21+
.. code:: sh
22+
23+
python3 -m pip install buttons
24+
25+
Getting Started
26+
----------------------------
27+
A quick and easy paginator example:
28+
29+
.. code:: py
30+
from discord.ext import commands
31+
from discord.ext import buttons
32+
33+
34+
class MyPaginator(buttons.Paginator):
35+
36+
def __init__(self, *args, **kwargs):
37+
super().__init__(*args, **kwargs)
38+
39+
@buttons.button(emoji='\u23FA')
40+
async def record_button(self, ctx):
41+
await ctx.send('This button sends a silly message! But could be programmed to do much more.')
42+
43+
@buttons.button(emoji='my_custom_emoji:1234567890')
44+
async def silly_button(self, ctx):
45+
await ctx.send('Beep boop...')
46+
47+
48+
bot = commands.Bot(command_prefix='??')
49+
50+
51+
@bot.command()
52+
async def test(ctx):
53+
pagey = MyPaginator(title='Silly Paginator', colour=0xc67862, embed=True, timeout=90, use_defaults=True,
54+
entries=[1, 2, 3], length=1, format='**')
55+
56+
await pagey.start(ctx)
57+
58+
59+
@bot.event
60+
async def on_ready():
61+
print('Ready!')
62+
63+
64+
bot.run('TOKEN')

0 commit comments

Comments
 (0)