Rearrange readme and make it easier to understand

This commit is contained in:
Bella Who 2020-01-25 00:55:20 -05:00 committed by GitHub
parent f02c0c4bb3
commit 74ca879d0c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 33 deletions

View File

@ -10,52 +10,31 @@
| Media | [![Discord Mine](https://img.shields.io/discord/573954110454366214?label=chat&logo=discord&logoColor=white)](https://discord.gg/KfpqwZB) | [![Discord 086](https://img.shields.io/discord/496724196542513174)](http://discord.gg/9hvwgeg) |
| Version | [![Version master](https://img.shields.io/github/v/release/S-B99/kami?color=dark-green&label=latest&logo=java)](https://github.com/S-B99/KAMI/releases) | [![Version 086](https://img.shields.io/github/v/tag/zeroeightysix/KAMI?color=red&label=outdated)](https://github.com/zeroeightysix/KAMI/releases) |
<!--| Issues | [![Issues Mine](https://img.shields.io/github/issues/S-B99/KAMI?label=issues&logo=github)](https://github.com/S-B99/kami/issues) | [![Issues 086](https://img.shields.io/github/issues/zeroeightysix/KAMI?color=red&label=issues)](https://github.com/zeroeightysix/kami/issues) |-->
<!--| Build Status | [![Build Status features-master](https://img.shields.io/travis/com/S-B99/KAMI/features-master?label=build)](https://travis-ci.com/S-B99/KAMI/tree/features-master) | [![Build Status master](https://img.shields.io/travis/com/S-B99/KAMI/master?label=build)](https://travis-ci.com/S-B99/KAMI/tree/master) | [![Build Status 086](https://travis-ci.com/zeroeightysix/KAMI.svg?branch=master)](https://travis-ci.com/zeroeightysix/KAMI) |-->
<!--| Issues | [![Issues Mine](https://img.shields.io/github/issues/S-B99/KAMI?label=issues)](https://github.com/S-B99/kami/issues) | [![Issues Mine](https://img.shields.io/github/issues/S-B99/KAMI?label=issues)](https://github.com/S-B99/kami/issues) | [![Issues 086](https://img.shields.io/github/issues/zeroeightysix/KAMI?color=red&label=issues)](https://github.com/zeroeightysix/kami/issues) |-->
<!--| Media | [![Discord Mine](https://img.shields.io/discord/573954110454366214?label=chat&logo=discord&logoColor=white)](https://discord.gg/KfpqwZB) | [![Discord Mine](https://img.shields.io/discord/573954110454366214?label=chat&logo=discord&logoColor=white)](https://discord.gg/KfpqwZB) | [![Discord 086](https://img.shields.io/badge/chat-on%20discord-brightgreen.svg)](http://discord.gg/9hvwgeg) |-->
<!--| Version | [![Version features-master](https://img.shields.io/github/v/tag/S-B99/KAMI?color=orange&include_prereleases&label=unstable&sort=semver)](https://github.com/S-B99/KAMI/releases) | [![Version master](https://img.shields.io/github/v/release/S-B99/kami?color=dark-green&label=latest)](https://github.com/S-B99/KAMI/releases) | [![Version 086](https://img.shields.io/github/v/tag/zeroeightysix/KAMI?color=red&label=outdated)](https://github.com/zeroeightysix/KAMI/releases) |-->
Please consider donating to help continue this project and get a unique cape in game.
[![Paypal](https://img.shields.io/badge/paypal-donate-red?color=169bd7&logo=paypal)](https://paypal.me/bellawhotwo)
[![BTC](https://img.shields.io/badge/btc-clickme-red?color=f08b16&logo=bitcoin)](https://www.blockchain.com/btc/address/19pH4aNZZMPJkqQ2826BauRokyBs1NYon7)
[![BCH](https://img.shields.io/badge/bch-clickme-red?color=2db300&logo=cash-app)](https://www.blockchain.com/bch/address/19pH4aNZZMPJkqQ2826BauRokyBs1NYon7)
Please consider donating to help continue this project and get a unique cape in game.
<a href="https://www.github.com/S-B99/KAMI/releases">
<img src="https://github.com/S-B99/KAMI/blob/assets/assets/icons/download.svg" width="250"/>
</a>
Also note Baritone is no longer included. Download the standalone jar [from here](https://github.com/cabaletta/baritone/releases/tag/v1.2.10).
<details>
<summary>Click to view disclaimers</summary>
***
This will be frequently updated as long as I'm not on vacation or anything
This is by no means a finished project, nor is it a "cheat" or "hack" for anything, it is a *utility* mod.
Please note Baritone is no longer included. Download the standalone jar [from here](https://github.com/cabaletta/baritone/releases) The latest 1.12.2 jar is [this](https://github.com/cabaletta/baritone/releases/tag/v1.2.10).
See [forgehax](https://github.com/fr1kin/forgehax) for an equivalent. Some features in KAMI may be based on those of forgehax, and KAMI / KAMI Blue have some features it doesn't. KAMI Blue won't be based off of other mods unless said otherwise.
***
</details>
<a href="https://www.github.com/S-B99/KAMI/releases">
<img src="https://github.com/S-B99/KAMI/blob/assets/assets/icons/download.svg" width="250"/>
## Status
<details>
<summary>Click to view current development status</summary>
***
Please see the [issues](https://github.com/S-B99/KAMI/issues/12) page for planned features and bugs to fix.
This is currently in active development. When issues are being closed is by milestone, and bugs are higher priority, though there aren't any that break anything completely.
***
</details>
## Installing
To install drag the `VERSION-release.jar` to your `mods/1.12.2` folder
@ -77,7 +56,7 @@ KAMI Blue is a forge mod. Start by downloading the latest version of [1.12.2 for
</details>
## How do I
## FAQ
<details>
<summary>Click to see the frequently asked questions or basic stuff</summary>
@ -106,9 +85,7 @@ By using the command `prefix <prefix>` or after having ran KAMI Blue (make sure
***
Click on images to expand
***
### Click on images to expand
Capes in game
@ -128,6 +105,21 @@ CrystalAura targeting
***
## Status
<details>
<summary>Click to view current development status</summary>
***
Please see the [issues](https://github.com/S-B99/KAMI/issues/) page for planned features and bugs to fix.
This is currently in active development. When issues are being closed is by milestone, and bugs are higher priority, though there aren't any that break anything completely.
***
</details>
## Building and Contributing
<details>