Skip to content

Commit 4f8d3d1

Browse files
committed
Doc: Added usage example in README
1 parent ed6961e commit 4f8d3d1

1 file changed

Lines changed: 28 additions & 1 deletion

File tree

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Portable Minecraft Launcher
1+
# PortableMC
22
Cross platform command line utility for launching Minecraft quickly and reliably with
33
included support for Mojang versions and popular mod loaders. It is also available as
44
a Rust crate for developers ~~and bindings for C and Python~~ (yet to come).
@@ -12,6 +12,7 @@ a Rust crate for developers ~~and bindings for C and Python~~ (yet to come).
1212
- [Cargo](#cargo)
1313
- [Linux third-party packages](#linux-third-party-packages)
1414
- [Arch Linux](#arch-linux)
15+
- [Usage](#usage)
1516
- [Contribute](#contribute)
1617
- [Repositories](#repositories)
1718
- [Contributors](#contributors)
@@ -87,6 +88,32 @@ Arch Linux packages are maintained by PortableMC team.
8788

8889
Prebuilt binaries requires you to install the PGP certificate, as described [above](#binaries).
8990

91+
## Usage
92+
93+
This section shows example usage to get started with PortableMC.
94+
95+
```shell
96+
# Start the latest Mojang release, with a random username and default options...
97+
portablemc start
98+
99+
# Start a specific version, let's say 1.16.5...
100+
portablemc start 1.16.5
101+
# You can list the Mojang versions...
102+
portablemc search
103+
# Search on the release versions, and limit to 10 entries...
104+
portablemc search --channel release -l10
105+
106+
# Choose your username in offline mode...
107+
portablemc start -u MyUsername
108+
109+
# Authenticate into your Minecraft account...
110+
portablemc auth login
111+
# List your authenticated accounts...
112+
portablemc auth list
113+
# Start the game with your authenticated account...
114+
portablemc start -u <your username> -a
115+
```
116+
90117
## Contribute
91118

92119
### Repositories

0 commit comments

Comments
 (0)