Skip to content

Commit 63e6530

Browse files
Polish readme file
Some minor error fixes in the readme file.
1 parent f6a4cf7 commit 63e6530

File tree

1 file changed

+19
-18
lines changed

1 file changed

+19
-18
lines changed

README.md

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,33 @@
22
Minecraft Controller written in Rust (mc ctrl rs).
33

44
## What is this project about?
5-
This is a Minecraft server sidecar, a web server that can be run alongside the
6-
Minecraft server and can communicate to it using the RCON protocol.
5+
This is a Minecraft server sidecar - a web server that can be run alongside the
6+
Minecraft server and can communicate with it using the RCON protocol.
77

8-
It has some basic functionality to display the number of online players with a
9-
list of them and also show show the tick stats.
8+
It has some basic functionality to display the number of online players, show a
9+
list of them, and also show the tick stats.
1010

1111
However, the main goal of the project is to switch between multiple different
12-
worlds. Me and my friends are playing Minecraft for a while and we periodically
13-
create a new world when big enough update drops and changes a lot in the world
14-
generation routines. It is fun though to come back to our old worlds from time
15-
to time and explore what we did when we get nostalgic.
12+
worlds. Me and my friends have been playing Minecraft for a while, and we
13+
periodically create a new world when a big enough update drops and changes a lot
14+
in the world generation routines. It is fun to come back to our old worlds from
15+
time to time and explore what we did when we get nostalgic.
1616

17-
This is exactly what this tool is for - it allows switch between multiple world
18-
directories. It will first shutdown the server, change the configuration file
19-
to point to a different folder and then restart it back up.
17+
This is exactly what this tool is for - it allows switching between multiple
18+
world directories. It will first shut down the server, change the configuration
19+
file to point to a different folder, and then restart it back up.
2020

2121
This project comes with two modes: a server and a management tool.
2222

2323
A server can be started by using the `mctrlrs server` command and is
24-
essentially a sidecar with the web interface.
24+
essentially a sidecar with a web interface.
2525

26-
A management tool is a CLI that allows to manage users for web interface
27-
access, including enrolling new users with registration link that can be sent
28-
to somebody to set their own password, reset their password or remove a user.
29-
This functionality can be accessed with `mctrlrs manage user` subcommand.
26+
The management tool is a CLI that allows you to manage users for web interface
27+
access, including enrolling new users with a registration link that can be sent
28+
to somebody to set their own password, reset their password, or remove a user.
29+
This functionality can be accessed with the `mctrlrs manage user` subcommand.
3030

31-
It also allows to manage worlds: listing available worlds and switching between
32-
them, similarly to what the web interface would do. This can be done via the
31+
It also allows you to manage worlds: list available worlds and switch between
32+
them, similarly to what the web interface does. This can be done via the
3333
`mctrlrs manage world` subcommand.
34+

0 commit comments

Comments
 (0)