Skip to content

Commit aaef659

Browse files
committed
Update readme
1 parent 7975b5b commit aaef659

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

+13-7
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# mac-registration-provider
2-
A small service that generates iMessage registration data on a Mac. If you do not have access to Beeper Cloud, you can use this to generate a iMessage Registration Code and use it in Beeper Mini.
2+
A small service that generates iMessage registration data on a Mac. If you do
3+
not have access to Beeper Cloud, you can use this to generate an iMessage
4+
registration code and use it in Beeper Mini.
35

46
## Supported MacOS versions
57
The tool is currently quite hacky, so it only works on specific versions of macOS.
@@ -11,17 +13,21 @@ On unsupported versions, it will tell you that it's unsupported and exit.
1113
A future version may work in less hacky ways to support more OS versions.
1214

1315
## Usage
14-
1. On your Mac, download the latest `mac-registration-provider` file from the latest [release](https://github.com/beeper/mac-registration-provider/releases)
15-
![CleanShot 2023-12-21 at 14 32 42@2x](https://github.com/beeper/mac-registration-provider/assets/1048265/4a419ae1-8996-4af4-876e-5723db088816)
16-
2. Open Terminal app (⌘+space -> Terminal), type `cd Downloads`, hit enter
17-
3. type `chmod +x mac-registration-provider`, hit enter
18-
4. Type `./mac-registration-provider`, hit enter
16+
1. On your Mac, download the latest `mac-registration-provider` file from the
17+
latest [release](https://github.com/beeper/mac-registration-provider/releases)
1918

19+
![screenshot](https://github.com/beeper/mac-registration-provider/assets/1048265/4a419ae1-8996-4af4-876e-5723db088816)
20+
2. Open Terminal app (<kbd>⌘</kbd> + <kbd>space</kbd> -> Terminal), type `cd Downloads`, hit enter
21+
3. Type `chmod +x mac-registration-provider`, hit enter
22+
4. Type `./mac-registration-provider`, hit enter
2023

2124
## Future improvements
2225
If anyone wants to package this into an app that lives in your dock and runs at startup, we'd appreciate it!
2326

24-
## Optional parameters:
27+
## Modes of operation
28+
The service has three different modes of operation, and various flags associated
29+
with each mode. Only one mode can be used at a time. The only mode that works
30+
with Beeper is Relay, which is the default.
2531

2632
* Relay (default) - connect to a websocket and return registration data when the server requests it.
2733
* `-relay-server` Use a different relay server (defaults to `https://registration-relay.beeper.com`).

0 commit comments

Comments
 (0)