Skip to content

Commit f139a88

Browse files
committed
Update: All Centered Images + Removed Unused Import, Alphabetized HTML
Tags.
1 parent 310f5a6 commit f139a88

File tree

3 files changed

+34
-22
lines changed

3 files changed

+34
-22
lines changed

.markdownlint.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"MD033": {
3-
"allowed_elements": ["div", "h1", "h4", "b", "br", "code"]
3+
"allowed_elements": ["b", "br", "code", "div", "h1", "h4"]
44
},
55
"MD013": false,
66
"MD041": false

README.md

+33-19
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<div align="center">
22
<h1> Discord Activity Badge <code>(Initial Release)🌇</code></h1>
3-
4-
3+
4+
55
[![Example Online](https://badgen.net/badge/Discord%20Activity/Currently%20Online/green?icon=discord)](https://github.com/CodexLink/discord-activity-badge)
66
[![Example Idle](https://badgen.net/badge/Discord%20Activity/Currently%20Idle/yellow?icon=discord)](https://github.com/CodexLink/discord-activity-badge)
77
[![Example DND](https://badgen.net/badge/Discord%20Activity/Do%20Not%20Disturb/red?icon=discord)](https://github.com/CodexLink/discord-activity-badge)
@@ -38,17 +38,7 @@
3838

3939
**Because why not?** If you ever wanted to show your status with context aside from your Github Status, or wanting to go beyond styling your README by adding some extra toppings, or wanting to let some birds (strangers) know what you are doing at some point in time, then this action workflow might be for you!
4040

41-
## What it can do and what does it contain?
42-
43-
* Containerized with Docker and Cached with Buildx (in Github Actions)
44-
* Contains Discord Client Handler
45-
* Contains Custom Async Rewrite based on PyGithub
46-
* It can run locally and Remote with Github Actions (ONLY)
47-
* Python Code Annotated and Typed, Implemented under Async
48-
* String Manipulation and Logic for Badge Construction
49-
* Customizable Badge Output and others
50-
* With Dependency Management, Poetry
51-
* Utility functions that can be reusable, and etc.
41+
>Disclaimer: I did this for fun. But that fun were took over my standards. Check out [wiki](https://github.com/CodexLink/discord-activity-badge/wiki) for more information.</pre>
5242
5343
## Steps
5444

@@ -65,19 +55,27 @@ The following contains the steps needed to make this action work properly. Keep
6555
Ever since I don't provide anything such as the Bot that I use for reading my activities, you have to make it on your own. You can go to [Discord Developers](https://discord.com/developers/) and start ahead by creating a new application.
6656

6757
<div align="center">
68-
58+
6959
[![Image 1](https://github.com/CodexLink/discord-activity-badge/blob/latest/img/1.png)](https://github.com/CodexLink/discord-activity-badge/)
7060

7161
</div>
72-
62+
7363
Once you have created a new application, you have to go to the sidebar or menu and go to the **Bot settings**, and add a bot. And then, copy the token and store it somewhere temporarily as we are going to use it later on in the next two steps.
7464

65+
<div align="center">
66+
7567
[![Image 2](https://github.com/CodexLink/discord-activity-badge/blob/latest/img/2.gif)](https://github.com/CodexLink/discord-activity-badge/)
7668

69+
</div>
70+
7771
As a side note, you have to enable the presence and server members intent **on the same settings (Bot settings)** to allow your bot to read your presence context and the members' states and other kinds of stuff about them.
7872

73+
<div align="center">
74+
7975
[![Image 3](https://github.com/CodexLink/discord-activity-badge/blob/latest/img/3.png)](https://github.com/CodexLink/discord-activity-badge/)
8076

77+
</div>
78+
8179
*Don't forget to save before proceeding to the next step!!!*
8280

8381
### Inviting the Bot to a Guild
@@ -88,18 +86,22 @@ Keep in mind that, you can either **create your own guild** or have someone else
8886

8987
To invite, you have to go to the **OAuth2** settings and check the **OAuth2 URL Generator**. Look for **Bot** scope and check it, you will be given a generated link.
9088

89+
<div align="center">
90+
9191
[![Image 4, GIF](https://github.com/CodexLink/discord-activity-badge/blob/latest/img/4.gif)](https://github.com/CodexLink/discord-activity-badge/)
9292

93-
Once you have the link, you just have to paste it into the browser and open it.
93+
</div>
9494

95-
[![Image 5, GIF](https://github.com/CodexLink/discord-activity-badge/blob/latest/img/5.gif)](https://github.com/CodexLink/discord-activity-badge/)
95+
Once you have the link, you just have to paste it into the browser and open it.
9696

9797
<div align="center">
9898

99+
[![Image 5, GIF](https://github.com/CodexLink/discord-activity-badge/blob/latest/img/5.gif)](https://github.com/CodexLink/discord-activity-badge/)
100+
99101
[![Image 6](https://github.com/CodexLink/discord-activity-badge/blob/latest/img/6.png)](https://github.com/CodexLink/discord-activity-badge/)
100102

101103
</div>
102-
104+
103105
And there you have it! Once you have done this part, the only thing left is to have a workflow in your repository.
104106

105107
### Preparing the Workflow
@@ -135,20 +137,32 @@ jobs:
135137

136138
To be able to provide your information, you have to go to your repository > Settings > Secrets > New Repository.
137139

140+
<div align="center">
141+
138142
[![Image 7](https://github.com/CodexLink/discord-activity-badge/blob/latest/img/7.png)](https://github.com/CodexLink/discord-activity-badge/)
139143

144+
</div>
145+
140146
In the end, you should have these two repository secrets. The token is from the one that we obtained in the Discord Developers Section, and the one is from you yourself in the Discord Client.
141147

142148
**DISCORD_USER_ID** can be obtained by the following.
143149

150+
<div align="center">
151+
144152
[![Image 8, GIF](https://github.com/CodexLink/discord-activity-badge/blob/latest/img/8.gif)](https://github.com/CodexLink/discord-activity-badge/)
145153

154+
</div>
155+
146156
### Workflow Dispatch
147157

148158
When you finished all the steps, the last thing to do was to manually push it to see changes.
149159

160+
<div align="center">
161+
150162
[![Image 9](https://github.com/CodexLink/discord-activity-badge/blob/latest/img/9.png)](https://github.com/CodexLink/discord-activity-badge/)
151163

164+
</div>
165+
152166
### Post-Step, Moving the Badge
153167

154168
If you did the run for the first time, the badge will tend to append on the top of your README, you can adjust it to somewhere else and the badge will be replaced by the script, no matter where it is.
@@ -340,4 +354,4 @@ Some of the questions here were snipped. They will redirect you to the answer.
340354
http://www.apache.org/licenses/LICENSE-2.0
341355
```
342356

343-
You may see the [LICENSE.md](https://github.com/CodexLink/discord-rich-presence-activity-badge/blob/main/LICENSE) file for more information.
357+
You may see the [LICENSE](https://github.com/CodexLink/discord-rich-presence-activity-badge/blob/main/LICENSE) file for more information.

src/utils.py

-2
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,6 @@
2323
from sys import stdout
2424
from typing import Any, Optional, Type, Union
2525

26-
from discord import message
27-
2826
from elements.constants import (
2927
ARG_CONSTANTS,
3028
ENV_FILENAME,

0 commit comments

Comments
 (0)