Skip to content

Improve README.md #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nullved merged 1 commit into from
Jun 14, 2025
Merged

Improve README.md #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 18 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,30 @@
![PMWeatherAPI Logo](https://cdn.modrinth.com/data/cached_images/f7b06beba44c5d08763305f5a0c3480611610230.png)

## Support
You can get support on my discord server [here](https://discord.gg/B6YKNVB6pW)!

Need help? Join the Discord server [here](https://discord.gg/B6YKNVB6pW)!

## About
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.

Current Features include:
- Nearby Storm Detection
- Nearby Radar Detection
- Radar Overlays
![pmweatherapi](https://img.shields.io/maven-metadata/v?label=pmweatherapi\&metadataUrl=https://maven.digitalunderworlds.com/snapshots/net/nullved/pmweatherapi/maven-metadata.xml)

**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.

### Current features:

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

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)
> ⚠️ This API is currently experimental due to PMWeather still being in alpha. Bugs should be expected.
> The API will aim to stay updated with PMWeather as closely as possible.

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).

## Adding to Your Project

## Adding to your project
In your `build.gradle`, add the following:

```groovy
repositories {
maven {
Expand All @@ -31,4 +38,4 @@ dependencies {
}
```

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