Skip to content
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

Updated README and simplified it where possible. #113

Merged
merged 1 commit into from
Jul 11, 2022
Merged

Updated README and simplified it where possible. #113

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
57 changes: 29 additions & 28 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
## Description
This library contains a collection of modules that assist with the development of console applications and Minecraft plugins.

A [list of features](https://github.com/Preponderous-Software/Ponder/wiki/Features) is available on the wiki.

## Projects

A [list of projects](https://github.com/Preponderous-Software/Ponder/wiki/Projects) is available on the wiki.
Expand All @@ -17,12 +15,6 @@ For support, you can join our [support discord server](https://discord.gg/G6wQxf

Please [fill out a bug report here](https://github.com/Preponderous-Software/Ponder/issues?q=is%3Aissue+is%3Aopen+label%3Abug).

## Installation/Configuration

For help with installation/configuration, check
out [this page](https://github.com/Preponderous-Software/Ponder/wiki/Setup-Tutorial-(Configuration)). Please keep in
mind that while this library can be used, it is unstable and likely to change.

## Example Application

An example of an application created with Ponder can be
Expand All @@ -35,50 +27,59 @@ found [here](https://github.com/Preponderous-Software/ExamplePonderPlugin).

## Maven

- Maven Dev Build
### repository

```
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
<id>dansplugins.com</id>
<url>https://repo.dansplugins.com/repository/maven-public/</url>
</repository>
```

### ponder-bukkit

```

<dependency>
<groupId>com.github.Preponderous-Software</groupId>
<artifactId>Ponder</artifactId>
<version>07e0c073e9</version>
<groupId>com.dansplugins</groupId>
<artifactId>ponder-bukkit</artifactId>
<version>2.0.0</version>
</dependency>
```

- Maven Release
### ponder-cache

```
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>

<dependency>
<groupId>com.github.Preponderous-Software</groupId>
<artifactId>Ponder</artifactId>
<version>1.1</version>
<groupId>com.dansplugins</groupId>
<artifactId>ponder-cache</artifactId>
<version>2.0.0</version>
</dependency>
```

## Contributing
### ponder-commands

```

- [Notes on Contributing](https://github.com/Preponderous-Software/Ponder/wiki/Contributing)
<dependency>
<groupId>com.dansplugins</groupId>
<artifactId>ponder-commands</artifactId>
<version>2.0.0</version>
</dependency>
```

## Authors and acknowledgement

Name | Main Contributions
------------ | -------------
[Daniel Stephenson](https://github.com/dmccoystephenson) | Creator
Callum | wrote some methods that are used in AbstractPluginCommand and ApplicationCommand; contributed NMSAssistant and NMSVersion; improved ColorChecker; contributed ColorConverter; improved EventHandlerRegistry; improved UUIDChecker; improved ArgumentParser; contributed ConfigurationFile
[Pasarus](https://github.com/Pasarus) | wrote code that is used in JsonWriterReader and UUIDChecker; contributed Pair
Caibinus | wrote code that is used in BlockChecker
Callum | wrote some methods that were used in AbstractPluginCommand and ApplicationCommand; contributed NMSAssistant and NMSVersion; improved ColorChecker; contributed ColorConverter; improved EventHandlerRegistry; improved UUIDChecker; improved ArgumentParser; contributed ConfigurationFile
[Pasarus](https://github.com/Pasarus) | wrote code that was used in JsonWriterReader and UUIDChecker; contributed Pair
Caibinus | wrote code that was used in BlockChecker
Deej | Set up the javadocs
VoChiDanh | Improved the BlockChecker and added the MaterialChecker
alyphen | Generified types of maps, lists and sets across the project, massively overhauled the project and split it into three modules
alyphen | Generified types of maps, lists and sets across the project, massively overhauled the project and split it into three modules, introduced tests

Have you made a contribution and don't see yourself above? Please add your name and open a PR!

Expand Down