Skip to content

Commit 5ee6959

Browse files
authored
Update README.md
1 parent 64f24e6 commit 5ee6959

File tree

1 file changed

+17
-27
lines changed

1 file changed

+17
-27
lines changed

README.md

Lines changed: 17 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -40,18 +40,15 @@ For more information check out the [wiki](https://override.gitbook.io/scptoolsbo
4040
For more indepth explanation see the [wiki](https://override.gitbook.io/scptoolsbot)
4141

4242
## Installation
43-
> [!NOTE]
44-
> Bots have to run all the time to be effective, so make sure to run it on a machine that is online 24/7
45-
46-
You can easily install the bot by downloading and installing the `installer.sh` from the latest release. For more installation info you can look into the [installation guide](https://override.gitbook.io/scptoolsbot/setup/getting-started) which covers docker installation etc.
4743

44+
### Quick Install
45+
Install the installer from the latest release or download it from the master branch:
4846
```sh
49-
chmod +x installer.sh
50-
51-
sudo ./installer.sh
47+
sudo sh -c "$(curl -fsSL https://raw.githubusercontent.com/Vxrpenter/SCPToolsBot/master/installer.sh)"
5248
```
49+
For more (detailed) installation methods, look into the setup guide:
5350

54-
## Build from Source
51+
### Build from Source
5552
```sh
5653
git clone https://github.com/Vxrpenter/SCPToolsBot
5754

@@ -62,9 +59,8 @@ chmod +x gradlew
6259
```
6360

6461
## Handling Issues
65-
If you're running into any issues,
66-
please first check the [wiki](https://override.gitbook.io/scptoolsbot) for help.
67-
If you can't fix the issue, create an issue here so we're able to review it and find possible bugs. If you have any questions about the working or plans of development contact `@vxrpenter` on discord
62+
If you're running into any issues, please first check the [wiki](https://override.gitbook.io/scptoolsbot) for help.
63+
If you can't fix the issue, create an issue here so we're able to review it and find possible bugs. If you have any questions about the working or plans of development contact `@vxrpenter` on discord, or open up a [discussion](https://github.com/Vxrpenter/SCPToolsBot/discussions/new?category=questions)
6864

6965
---
7066

@@ -74,25 +70,19 @@ If a release contains the `alpha` tag, it is experimental and features and more
7470

7571
Releases containing the `beta` tag are mostly tested but could still be considered unstable.
7672

77-
Releases will be marked as stable if they're thought to run well after testing.
78-
If a release is marked as unstable, it might not run well or produce bugs, for example, memory leaks
79-
80-
When a new build is released, it might take some time until the wiki is updated
81-
82-
Changelogs only contain the most important information,
83-
and small one-line changes will not be included if they don't have a major effect on stability and/or performance
84-
8573
## Licencing
86-
This project, as stated above, is licenced under the MIT license.
87-
It can be modified and used commercially.
88-
You can distribute it as you like.
89-
I'm not liable for anything done with it, and no warranty is given
90-
9174
> [!IMPORTANT]
92-
> When using code from this repo, you have to add a License and copyright notice.
75+
> Copyright (c) 2024 Vxrpenter and the SCPToolsBot Contributors
76+
>
77+
> Licenced under the MIT License, any non-license compliant usage of this projects file(s) content
78+
> is prohibited. You can find the complete license agreement [here](https://github.com/Vxrpenter/SCPToolsBot/blob/master/LICENSE)
79+
>
80+
> This software may be used commercially if the usage is license compliant. The software
81+
> is provided without any sort of WARRANTY, and the authors cannot be held liable for
82+
> any form of claim, damages or other liabilities.
9383
94-
This license is not in place to annoy anyone but to protect the work, passion and time that has gone into this project
95-
> This is no legal advice
84+
> [!NOTE]
85+
> This is no legal advice, please read the license conditions
9686
9787
## Special Thanks
9888
- Special thanks goes to [ced777ric](https://github.com/ced777ric) who helped me a lot with the cedmod api integration, especially when trying to find the specific endpoints use case or usability

0 commit comments

Comments
 (0)