Skip to content

Commit ea3491f

Browse files
authored
Improve README (#105)
2 parents 93ea9fd + 0c2764b commit ea3491f

File tree

1 file changed

+56
-21
lines changed

1 file changed

+56
-21
lines changed

README.md

Lines changed: 56 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,68 @@
1-
[![Banner](https://i.ibb.co/2yFTQ8X/banner-optimised.png)](https://modrinth.com/plugin/Dc8RS2En/)
2-
31
# Bank Accounts
4-
[![Available on Modrinth](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/available/modrinth_vector.svg)](https://modrinth.com/plugin/Dc8RS2En)
5-
[![Available for Paper](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/supported/paper_vector.svg)](https://papermc.io/software/paper)
6-
[![Available on GitHub](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/available/github_vector.svg)](https://github.com/cloudnode-pro/BankAccounts/)
2+
[![Available on Modrinth](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/available/modrinth_vector.svg)](https://modrinth.com/plugin/Dc8RS2En) [![Available for Paper](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/supported/paper_vector.svg)](https://papermc.io/software/paper) [![Available on GitHub](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/available/github_vector.svg)](https://github.com/cloudnode-pro/BankAccounts/)
3+
4+
[![Java CI with Maven](https://github.com/cloudnode-pro/BankAccounts/actions/workflows/maven.yml/badge.svg)](https://github.com/cloudnode-pro/BankAccounts/actions/workflows/maven.yml) [![CodeQL](https://github.com/cloudnode-pro/BankAccounts/actions/workflows/codeql.yml/badge.svg)](https://github.com/cloudnode-pro/BankAccounts/actions/workflows/codeql.yml) [![Version](https://img.shields.io/modrinth/v/Dc8RS2En)](https://modrinth.com/plugin/Dc8RS2En/version/latest) [![Game Versions](https://img.shields.io/modrinth/game-versions/Dc8RS2En)](https://modrinth.com/plugin/Dc8RS2En/) [![Downloads](https://img.shields.io/modrinth/dt/Dc8RS2En)](https://modrinth.com/plugin/Dc8RS2En/)
5+
6+
A Minecraft economy plugin that enables players to hold multiple bank accounts.
7+
8+
[**`Download`**](https://modrinth.com/plugin/Dc8RS2En/version/latest)
9+
10+
## Features
11+
12+
See also: [Commands](https://github.com/cloudnode-pro/BankAccounts/wiki/Commands) · [Permissions](https://github.com/cloudnode-pro/BankAccounts/wiki/Permissions)
13+
14+
### Multiple Accounts/Balances
15+
Players can have multiple independent bank accounts. You can have both personal and business accounts.
16+
17+
### Transaction History
18+
See the history of your account’s transactions using the `/bank history` command.
19+
20+
### Payment Requests (Invoices)
21+
Request money from players and track the payment status.
22+
23+
### POS and Bank Cards
724

8-
[![CodeQL](https://github.com/cloudnode-pro/BankAccounts/actions/workflows/codeql.yml/badge.svg)](https://github.com/cloudnode-pro/BankAccounts/actions/workflows/codeql.yml)
9-
[![Version](https://img.shields.io/modrinth/v/Dc8RS2En)](https://modrinth.com/plugin/Dc8RS2En/)
10-
[![Game Versions](https://img.shields.io/modrinth/game-versions/Dc8RS2En)](https://modrinth.com/plugin/Dc8RS2En/)
11-
[![Downloads](https://img.shields.io/modrinth/dt/Dc8RS2En)](https://modrinth.com/plugin/Dc8RS2En/)
25+
You can create a [Point of Sale](https://github.com/cloudnode-pro/BankAccounts/wiki/POS), which is a type of single-use chest shop. Players can pay using a bank card (`/bank card`).
1226

13-
A multi-account economy plugin.
27+
### Extensive Configuration
1428

15-
[**`Features (Wiki)`**](https://github.com/cloudnode-pro/BankAccounts/wiki)
16-
· [**`Commands`**](https://github.com/cloudnode-pro/BankAccounts/wiki/Commands)
17-
· [**`Permissions`**](https://github.com/cloudnode-pro/BankAccounts/wiki/Permissions)
18-
· [**`Download`**](https://modrinth.com/plugin/Dc8RS2En/version/latest)
29+
All functionality is fully configurable. See [default config](https://github.com/cloudnode-pro/BankAccounts/blob/master/src/main/resources/config.yml).
30+
31+
## Support
32+
33+
| Matrix | [bankaccounts:cloudnode.pro](https://matrix.to/#/#bankaccounts:cloudnode.pro) |
34+
|--------|-------------------------------------------------------------------------------|
35+
36+
Join our dedicated BankAccounts community space on Matrix to engage in discussions, receive support, and stay updated on crucial plugin announcements.
37+
38+
If you want to report a problem or request a feature, please [submit a new issue](https://github.com/cloudnode-pro/BankAccounts/issues/new?labels=bug).
39+
40+
## Release Cycle
41+
42+
BankAccounts follows a weekly **time-based release schedule**, with new features or changes typically released every **Tuesday**.
43+
44+
When we merge critical bug fixes, we may publish out-of-band releases on any day of the week.
1945

2046
## Report Issues
21-
If you discover any issues with the plugin, please first check the [known issues](https://github.com/cloudnode-pro/BankAccounts/issues?q=is%3Aopen+is%3Aissue+label%3Abug). If it is not listed there, please [create a new issue](https://github.com/cloudnode-pro/BankAccounts/issues/new?labels=bug). Fixing bugs is the highest priority for this project.
47+
Please ensure that you are using the [latest version](https://modrinth.com/plugin/Dc8RS2En/version/latest) of BankAccounts. The newest bug fixes are only available in the most recent version, and support is provided exclusively for this version.
2248

23-
When reporting an issue, please include as much relevant information as possible, including error logs, screenshots, and steps to reproduce the issue.
49+
If you encounter any problems with the plugin, please first check the [list of known issues](https://github.com/cloudnode-pro/BankAccounts/issues?q=is%3Aopen+is%3Aissue+label%3Abug) on our GitHub repository. If you don’t find a similar fault listed there, we encourage you to [submit a new issue](https://github.com/cloudnode-pro/BankAccounts/issues/new?labels=bug). Resolving bugs is the highest priority for this project.
2450

25-
Please make sure you are using the latest version of BankAccounts.
51+
To help us resolve your issue as quickly as possible, please provide as much relevant information as possible, including error logs, screenshots, and detailed steps to reproduce the problem.
2652

27-
## Request Features
28-
If you would like to request a new feature, please [open a new issue](https://github.com/cloudnode-pro/BankAccounts/issues/new) and describe what you have in mind.
53+
## Feature Requests
2954

30-
Due to each player having multiple accounts, it is difficult to integrate this project with other plugins. BankAccounts provides replacements for some such functionalities.
55+
To suggest a new feature, please [create a new issue](https://github.com/cloudnode-pro/BankAccounts/issues/new), providing a detailed description of your idea.
3156

3257
## Contributing
33-
If you would like to contribute to the project, you can [fork the repository](https://github.com/cloudnode-pro/BankAccounts/fork) and create a pull request.
58+
59+
New contributors are most welcome to the project.
60+
61+
If you're interested in contributing, follow these steps:
62+
63+
1. [Fork the repository](https://github.com/cloudnode-pro/BankAccounts/fork)
64+
2. Create a new branch for your contributions.
65+
3. Make your changes and ensure they align with the project’s goals.
66+
4. Commit your changes with clear and descriptive messages.
67+
5. Push your changes to your fork.
68+
6. Submit a pull request.

0 commit comments

Comments
 (0)