Skip to content

Commit

Permalink
docs: link to development docs in README (#214)
Browse files Browse the repository at this point in the history
* docs: add dev docs links to the README

* Update README.md

Split into paragraphs and clarify "development version"

---------

Co-authored-by: kangalio <[email protected]>
  • Loading branch information
ev3nvy and kangalio authored Oct 25, 2023
1 parent 8060012 commit e1a5312
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,12 @@ Poise is an opinionated Discord bot framework with a few distinctive features:

# How to use

Most information is in the [API documentation](https://docs.rs/poise/). Also take a look at the
[examples](examples), especially `feature_showcase`, to learn what poise can do.
Most information is in the [API documentation](https://docs.rs/poise/). Also take a
look at the [examples](examples), especially [`feature_showcase`](https://github.com/ev3nvy/poise/tree/current/examples/feature_showcase), to learn what poise can do.

If you're using a development version from git directly, you probably want to look at the documentation for
[`current`](https://serenity-rs.github.io/poise/current), [`next`](https://serenity-rs.github.io/poise/next)
or [`serenity-next`](https://serenity-rs.github.io/poise/serenity-next) branch instead.

For further questions, don't hesitate to join the support server: https://discord.gg/serenity-rs.

Expand Down

0 comments on commit e1a5312

Please sign in to comment.