Skip to content

Commit fc3b6be

Browse files
authored
Improve README.md from jackh54/patch-1
2 parents 8e51a2c + 8279df4 commit fc3b6be

1 file changed

Lines changed: 18 additions & 11 deletions

File tree

README.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,30 @@
11
![PMWeatherAPI Logo](https://cdn.modrinth.com/data/cached_images/f7b06beba44c5d08763305f5a0c3480611610230.png)
22

33
## Support
4-
You can get support on my discord server [here](https://discord.gg/B6YKNVB6pW)!
4+
5+
Need help? Join the Discord server [here](https://discord.gg/B6YKNVB6pW)!
56

67
## About
7-
PMWeatherAPI is an **Unofficial** API designed to make interacting with [ProtoManly's Weather Mod](https://modrinth.com/mod/protomanlys-weather/) easier for those wishing to create addons for PMWeather.
88

9-
Current Features include:
10-
- Nearby Storm Detection
11-
- Nearby Radar Detection
12-
- Radar Overlays
9+
![pmweatherapi](https://img.shields.io/maven-metadata/v?label=pmweatherapi\&metadataUrl=https://maven.digitalunderworlds.com/snapshots/net/nullved/pmweatherapi/maven-metadata.xml)
10+
11+
**PMWeatherAPI** is an **unofficial** API designed to simplify interacting with [ProtoManly's Weather Mod](https://modrinth.com/mod/protomanlys-weather/) for those who want to create addons.
12+
13+
### Current features:
1314

14-
This API is currently experimental (due to PMWeather being in alpha) and bugs are to be expected
15-
The API will try to keep up to date with PMWeather as much as possible.
15+
* Nearby storm detection
16+
* Nearby radar detection
17+
* Radar overlays
1618

17-
Please only use the version of the API compatible with your PMWeather version (for example, 0.14.15.0 is compatible with PMWeather 0.14.15-alpha, but not necessarily with other versions)
19+
> ⚠️ This API is currently experimental due to PMWeather still being in alpha. Bugs should be expected.
20+
> The API will aim to stay updated with PMWeather as closely as possible.
21+
22+
Make sure you only use the API version that matches your PMWeather version (e.g., `0.14.15.0` works with `PMWeather 0.14.15-alpha` but may not work with other versions).
23+
24+
## Adding to Your Project
1825

19-
## Adding to your project
2026
In your `build.gradle`, add the following:
27+
2128
```groovy
2229
repositories {
2330
maven {
@@ -31,4 +38,4 @@ dependencies {
3138
}
3239
```
3340

34-
To use the features of the mod, check out the [wiki](https://github.com/RealDarkStudios/PMWeatherAPI/wiki/)!
41+
For usage examples and more details, check out the [wiki](https://github.com/RealDarkStudios/PMWeatherAPI/wiki/).

0 commit comments

Comments
 (0)