Skip to content

Commit 022273d

Browse files
author
Eric Migicovsky
authored
Update README.md
1 parent a9b56f4 commit 022273d

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

+13-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# mac-registration-provider
2-
A small service that generates iMessage registration data on a Mac.
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.
33

4-
## Supported OS versions
4+
## Supported MacOS versions
55
The tool is currently quite hacky, so it only works on specific versions of macOS.
66

77
* Intel: 11.5 - 11.7, 14.0 - 14.3
@@ -11,7 +11,17 @@ On unsupported versions, it will tell you that it's unsupported and exit.
1111
A future version may work in less hacky ways to support more OS versions.
1212

1313
## Usage
14-
Put the binary on a Mac and run it (`./mac-registration-provider`), optionally with some parameters:
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
19+
20+
21+
## Future improvements
22+
If anyone wants to package this into an app that lives in your dock and runs at startup, we'd appreciate it!
23+
24+
## Optional parameters:
1525

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

0 commit comments

Comments
 (0)