Skip to content

Commit 9b21e10

Browse files
author
Lyzev
committed
Update README.md and MODULE.md for improved clarity and formatting
1 parent 6e38f10 commit 9b21e10

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

MODULE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
186186
GNU Affero General Public License for more details.
187187

188188
You should have received a copy of the GNU Affero General Public License
189-
along with this program. If not, see https://www.gnu.org/licenses/agpl-3.0.en.html.
189+
along with this program. If not, see [https://www.gnu.org/licenses/agpl-3.0.en.html](https://www.gnu.org/licenses/agpl-3.0.en.html).
190190

191191
# Package dev.lyzev.api.event
192192

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,14 @@ library. Simplify the process of registering listeners and triggering events wit
3030
> Piko is specifically designed for Kotlin and works best when used with Kotlin’s coding style. It’s strongly
3131
> recommended to use it exclusively with Kotlin.
3232
33-
## Key Features
33+
## :old_key: Key Features
3434

3535
- **Lightweight Framework**: Provides a streamlined framework for managing events and listeners.
3636
- **Intuitive API**: Offers an easy-to-use API for registering and triggering events.
3737
- **Reduced Boilerplate**: Minimizes boilerplate code by centralizing event management.
3838
- **Maintainable Logic**: Organizes listeners clearly to keep logic maintainable and easy to track.
3939

40-
## Installation
40+
## :package: Installation
4141

4242
[![Maven Central](https://cdn.jsdelivr.net/npm/@intergrav/[email protected]/assets/cozy/available/maven-central_vector.svg)](https://central.sonatype.com/artifact/dev.lyzev.api/piko)
4343

@@ -112,7 +112,7 @@ dependencies {
112112

113113
</details>
114114

115-
## Usage
115+
## :bulb: Usage
116116

117117
<details>
118118
<summary>Event Listener Example</summary>
@@ -174,7 +174,7 @@ class TestEvent(val a: Int) : CancellableEvent()
174174
> [!TIP]
175175
> The library is quite intuitive, so it's a good idea to try it out. You'll quickly learn its capabilities.
176176
177-
## Documentation
177+
## :books: Documentation
178178

179179
> [!WARNING]
180180
> This documentation is automatically generated by Dokka.
@@ -183,9 +183,9 @@ For documentation, check out the [Piko Documentation](https://schizoiddevelopmen
183183

184184
[![Documentation](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/documentation/ghpages_vector.svg)](https://schizoiddevelopment.github.io/piko/)
185185

186-
## Bugs and Suggestions
186+
## :lady_beetle: Bugs and Suggestions
187187

188-
### GitHub Issues
188+
### GitHub Issues :bug:
189189

190190
For bugs or suggestions, please submit them via
191191
the [GitHub Issue Tracker](https://github.com/SchizoidDevelopment/piko/issues). Be sure to use the provided templates
@@ -194,27 +194,27 @@ appreciated!
194194

195195
[![GitHub Issues](https://cdn.jsdelivr.net/npm/@intergrav/[email protected]/assets/cozy/documentation/issues_vector.svg)](https://github.com/SchizoidDevelopment/piko/issues)
196196

197-
### Discord Community
197+
### Discord Community :speech_balloon:
198198

199199
Need assistance or have **minor** questions? Join our welcoming community on
200200
the [Discord server](https://lyzev.dev/discord). Our members and staff are always ready to help!
201201

202202
[![Discord Server](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/social/discord-plural_vector.svg)](https://lyzev.dev/discord)
203203

204-
## Contribution Guidelines
204+
## :handshake: Contribution Guidelines
205205

206206
We welcome contributions from the community! Please read our [Contribution Guidelines](CONTRIBUTING.md) to get started.
207207

208208
[![Pull Requests](https://wsrv.nl/?url=https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/documentation/pull-requests_vector.svg)](https://github.com/SchizoidDevelopment/piko/pulls)
209209

210-
## Security Policy
210+
## :lock: Security Policy
211211

212212
Please review our [Security Policy](SECURITY.md) to understand how we handle security vulnerabilities.
213213

214214
> [!CAUTION]
215215
> Please do not publicly disclose the vulnerability until it has been fixed.
216216
217-
## License
217+
## :page_facing_up: License
218218

219219
Copyright (C) 2025 Lyzev
220220

0 commit comments

Comments
 (0)