📝 updated README #335
📝 updated README #335
Conversation
Codecov Report
@@ Coverage Diff @@
## main #335 +/- ##
=======================================
Coverage 90.54% 90.54%
=======================================
Files 8 8
Lines 74 74
=======================================
Hits 67 67
Misses 7 7 Continue to review full report at Codecov.
|
|
I think maintaining 2 READMEs is a terrible idea. Its be pretty easy to fix by using setuptools though but im not sure if we really want to add that complexity. Just putting the idea out there. |
Co-authored-by: trag1c <[email protected]>
Signed-off-by: Lunarmagpie <[email protected]>
|
|
||
| ## ☄️ Installation | ||
|
|
||
| Use the following command to install Pincer into your Python environment: | ||
|
|
||
| ```bash |
There was a problem hiding this comment.
omg wtf is this xD
Thx you so much
| To install our version with Aiohttp Speedup, use: | ||
|
|
||
| ```sh | ||
| pip install pincer[speed] | ||
| ``` | ||
|
|
There was a problem hiding this comment.
There is also img but instead of saying "to install ..." for all of them maybe should we put a table or something?
There was a problem hiding this comment.
This is outside the scope of what I want to do in this PR
docs/README.md
Outdated
| class Bot(Client): | ||
| @Client.event | ||
| async def on_ready(): | ||
| print(f"Logged in as {client.bot} after {perf_counter()} seconds") |
There was a problem hiding this comment.
shouldn't we use client repr? ...client as no repr implemented yet xD
There was a problem hiding this comment.
Im not doing this this PR cause I actually want it to be merged 💀
and i think its good how it is
| @@ -91,7 +88,7 @@ bot.run() | |||
|
|
|||
| **An example on the `on_ready` event** | |||
|
|
|||
| Pincer makes developing application commands intuitive and fast. | |||
| Pincer bots are required to inherit from the Client. | |||
There was a problem hiding this comment.
ye lol md template woudln't be too bad xD
|
I'm merging. The stuff that I didn't change but are requested changes I think should be done in a different PR since I don't want to be stuck maintaining this branch for a while. |
Changes
Check off the following