Skip to content

Commit 76a2735

Browse files
committed
First update
1 parent fbb8803 commit 76a2735

File tree

5 files changed

+83
-77
lines changed

5 files changed

+83
-77
lines changed

LICENSE

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
The MIT License (MIT)
22

3+
Copyright (c) 2021 The Nextcord Developers
34
Copyright (c) 2015-2020 Danny Y. (Rapptz)
45

56
Permission is hereby granted, free of charge, to any person obtaining a

README.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
### discord-ext-menus
1+
# nextcord-ext-menus
22

3-
An experimental extension menu that makes working with reaction menus a bit easier.
3+
## About
44

5-
**There are no front-facing docs for this and it's not on PyPI. As this is meant to be a repository for testing**
5+
A Nextcord extension that makes working with reaction menus a bit easier.
66

77
## Installing
88

9-
Installing is done purely via git:
9+
Python **>=3.6.0** is required.
1010

11-
```py
12-
python -m pip install -U git+https://github.com/Rapptz/discord-ext-menus
11+
```py
12+
pip install --upgrade nextcord-ext-menus
1313
```
1414

1515
## Getting Started
@@ -19,7 +19,7 @@ To whet your appetite, the following examples show the fundamentals on how to cr
1919
The first example shows a basic menu that has a stop button and two reply buttons:
2020

2121
```py
22-
from discord.ext import menus
22+
from nextcord.ext import menus
2323

2424
class MyMenu(menus.Menu):
2525
async def send_initial_message(self, ctx, channel):
@@ -52,7 +52,7 @@ If an error happens then an exception of type `menus.MenuError` is raised.
5252
This second example shows a confirmation menu and how we can compose it and use it later:
5353

5454
```py
55-
from discord.ext import menus
55+
from nextcord.ext import menus
5656

5757
class Confirm(menus.Menu):
5858
def __init__(self, msg):
@@ -105,7 +105,7 @@ None of these page sources deal with formatting of data, leaving that up to you.
105105
For the sake of example, here's a basic list source that is paginated:
106106

107107
```py
108-
from discord.ext import menus
108+
from nextcord.ext import menus
109109

110110
class MySource(menus.ListPageSource):
111111
def __init__(self, data):
@@ -125,7 +125,7 @@ The `format_page` can return either a `str` for content, `discord.Embed` for an
125125
Some more examples using `GroupByPageSource`:
126126

127127
```py
128-
from discord.ext import menus
128+
from nextcord.ext import menus
129129

130130
class Test:
131131
def __init__(self, key, value):
@@ -150,7 +150,7 @@ await pages.start(ctx)
150150
Another one showing `AsyncIteratorPageSource`:
151151

152152
```py
153-
from discord.ext import menus
153+
from nextcord.ext import menus
154154

155155
class Test:
156156
def __init__(self, value):
@@ -174,3 +174,8 @@ class Source(menus.AsyncIteratorPageSource):
174174
pages = menus.MenuPages(source=Source(), clear_reactions_after=True)
175175
await pages.start(ctx)
176176
```
177+
178+
## License
179+
180+
Copyright (c) 2021 The Nextcord Developers
181+
Copyright (c) 2015-2020 Danny Y. (Rapptz)

0 commit comments

Comments
 (0)