Skip to content
This repository has been archived by the owner on Apr 30, 2024. It is now read-only.

Commit

Permalink
Improve documentation
Browse files Browse the repository at this point in the history
	modified:   .gitignore
	modified:   README.md
	modified:   docs/lavasnek_rs.html
	modified:   docs/search.js
	modified:   src/lib.rs
  • Loading branch information
vicky5124 committed Feb 24, 2022
1 parent 51a8a1e commit e817a2e
Show file tree
Hide file tree
Showing 5 changed files with 317 additions and 298 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,5 @@ dist/
build/
.mypy_cache
*.so
.venv/
.venv/
test*
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# lavasnek_rs

Lavasnek is a lavalink wrapper for any asyncio python discord library. Lavalink is a standalone audio sending node for playing audio on discord voice channels.
It also has utilities like searching on several websites such as YouTube, Twitch and SoundCloud.

- Dev Docs: [Main Site](https://docs.vicky.rs/lavasnek_rs.html) | Fallback: [GitHub Pages](https://vicky5124.github.io/lavasnek_rs/lavasnek_rs/lavasnek_rs.html)
- [GitHub repo](https://github.com/vicky5124/lavasnek_rs/)
- [GitLab repo](https://gitlab.com/vicky5124/lavasnek_rs/)
- [GitLab mirror](https://gitlab.com/vicky5124/lavasnek_rs/)

## Using the library
## Installing the library

The library is available on PyPi, and you can install it via `pip install lavasnek_rs --pre -U --user`

Expand All @@ -14,7 +17,14 @@ and download the Artifact that suits your needs. Extract the artifact, and insta

Then you should be able to import the library and use it!

## Building and Running the hikari example
## Using the library

This library can be used with any asyncio based discord library, from hikari, to hata (with a compatibility layer), to any of the discord.py forks.

You can find basic examples using the library on the examples folder of the repository. Make sure to select the branch tag with the version you are using,
as the master branch could have differences that may not work on the current releases of lavasnek.

## Building the library

If you wanna build the project from source, (for contributing, compiling to a different architecture than
x86_64 or for python 3.10) you will need:
Expand Down
Loading

0 comments on commit e817a2e

Please sign in to comment.