Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
v10.0.0
closes #41
  • Loading branch information
switchupcb committed Dec 5, 2022
1 parent 07b2cc1 commit 02a5180
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 10 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,13 +72,11 @@ _Check out the [examples](/_examples/) directory for more._
Get a specific version of `disgo` by specifying a tag or branch.

```
go get github.com/switchupcb/disgo@v0.10.1
go get github.com/switchupcb/disgo@v10.0.0
```

_Disgo branches are referenced by API version (i.e `v10`)._

_DISCLAIMER: `v0.10.1` is a pre-release version. For more information, read the [State of Disgo (v0.10.1)](https://github.com/switchupcb/disgo/discussions/40)._

### Configuration

**You must create a Discord Application in the [Discord Developer Portal](https://discord.com/developers/docs/getting-started#creating-an-app) to receive your Bot Token.**
Expand Down
12 changes: 6 additions & 6 deletions _contribution/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ The repository contains a [README](/README.md), [Examples](/_examples/), [Code G

### Disgo

| Package | Description |
| :------ | :---------------- |
| wrapper | API Wrapper. |
| cache | Cache. |
| shard | Sharding Manager. |
| tools | Utility Tools. |
| Package | Description |
| :------ | :------------- |
| wrapper | API Wrapper. |
| cache | Cache. |
| shard | Shard Manager. |
| tools | Utility Tools. |

_A **bundler** is used to package the API into a `disgo` package (`disgo.go`)_.

Expand Down
2 changes: 1 addition & 1 deletion _gen/coverage/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Coverage Integration Test Generator

Disgo contains an integration test that covers a majority of the Discord API to ensure feature-complete functionality. This test entails calling 100+ endpoints (requests) and dealing with respective events as necessary. The test is run in the CI/CD pipeline used to approve a build for production-usage. It can also be used by developers to debug issues. As a result, it's important to optimize this task in order to _minimize the amount of time spent running tests_ in any given workflow.
Disgo contains an integration test that covers a majority of the Discord API to ensure feature-complete functionality. This test entails calling 60+ endpoints (requests) and dealing with respective events as necessary. The test is run in the CI/CD pipeline used to approve a build for production-usage. It can also be used by developers to debug issues. As a result, it's important to optimize this task in order to _minimize the amount of time spent running tests_ in any given workflow.

## Guide

Expand Down

0 comments on commit 02a5180

Please sign in to comment.