Skip to content

little redesign of README.md #224

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 2, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 37 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,43 @@
<img alt="" src="docs/_static/logo.svg" width="30%" />
<div align="center">

# Nextcore
A low level Discord API wrapper
<img alt="" src="docs/_static/logo.svg" width="160px"/>

# Nextcore
<sub>A low level Discord API wrapper.</sub>

</div>

### ✨ Features

- #### Speed

We try to make the library as fast as possible, without compromising on readability of the code or features.

<video src="https://user-images.githubusercontent.com/35035079/172221406-b8d618e6-75fd-45d4-a470-62aeeab5bc0a.mp4" />

## Features
### Speed
We try to make the library as fast as possible, without compromising on readability of the code or features.
<video src="https://user-images.githubusercontent.com/35035079/172221406-b8d618e6-75fd-45d4-a470-62aeeab5bc0a.mp4" />
- #### Modularity

### Modularity
All the components can easily be swapped out with your own.
All the components can easily be swapped out with your own.

### Control
Nextcore offers fine-grained control over things most libraries don't support.
- #### Control

Nextcore offers fine-grained control over things most libraries don't support.

This currently includes:
- Setting priority for individual requests
- Swapping out components

<br>

<div align="center">

# Examples

This currently includes:
- Setting priority for individual requests
- Swapping out components
</div>

## Examples
### Ping pong
### 🏓 Ping pong
A simple "ping pong" example in nextcore.
This will respond with "pong" each time someone sends "ping" in the chat.
```py
import asyncio
from os import environ
Expand Down Expand Up @@ -68,7 +86,9 @@ async def main():
asyncio.run(main())
```

More examples can be seen in the [examples](examples/) directory.
> More examples can be seen in the [examples](examples/) directory.

<br>

## Contributing
Want to help us out? Please read our [contributing](https://nextcore.readthedocs.io/en/latest/contributing/getting_started.html) docs.