Skip to content

Commit 4112d97

Browse files
committed
Update readme.md.
1 parent cffd26a commit 4112d97

File tree

5 files changed

+53
-0
lines changed

5 files changed

+53
-0
lines changed

async-discord.gemspec

+1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Gem::Specification.new do |spec|
1616
spec.homepage = "https://github.com/socketry/async-discord"
1717

1818
spec.metadata = {
19+
"documentation_uri" => "https://socketry.github.io/async-discord/",
1920
"source_code_uri" => "https://github.com/socketry/async-discord.git",
2021
}
2122

bake.rb

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# frozen_string_literal: true
2+
3+
# Released under the MIT License.
4+
# Copyright, 2024, by Samuel Williams.
5+
6+
# Update the project documentation with the new version number.
7+
#
8+
# @parameter version [String] The new version number.
9+
def after_gem_release_version_increment(version)
10+
context["releases:update"].call(version)
11+
context["utopia:project:readme:update"].call
12+
end

gems.rb

+1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
group :maintenance, optional: true do
1212
gem "bake-gem"
1313
gem "bake-modernize"
14+
gem "bake-releases"
1415

1516
gem "utopia-project"
1617
end

readme.md

+34
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,37 @@
11
# Async::Discord
22

33
Provides a simple `Async::REST` client for interacting with the Discord API.
4+
5+
[![Development Status](https://github.com/socketry/async-discord/workflows/Test/badge.svg)](https://github.com/socketry/async-discord/actions?workflow=Test)
6+
7+
## Usage
8+
9+
Please see the [project documentation](https://socketry.github.io/async-discord/) for more details.
10+
11+
- [Getting Started](https://socketry.github.io/async-discord/guides/getting-started/index) - This guide explains how to create a bot for Discord using the `async-discord` gem.
12+
13+
## Releases
14+
15+
Please see the [project releases](https://socketry.github.io/async-discord/releases/index) for all releases.
16+
17+
### v0.1.0
18+
19+
- Initial release.
20+
21+
## Contributing
22+
23+
We welcome contributions to this project.
24+
25+
1. Fork it.
26+
2. Create your feature branch (`git checkout -b my-new-feature`).
27+
3. Commit your changes (`git commit -am 'Add some feature'`).
28+
4. Push to the branch (`git push origin my-new-feature`).
29+
5. Create new Pull Request.
30+
31+
### Developer Certificate of Origin
32+
33+
In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.
34+
35+
### Community Guidelines
36+
37+
This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.

releases.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Releases
2+
3+
## v0.1.0
4+
5+
- Initial release.

0 commit comments

Comments
 (0)