Skip to content

Commit

Permalink
readme tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
cnuss committed Jan 15, 2024
1 parent e9cb19d commit 4305b25
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions imessage/bluebubbles/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@
1. Ignore Private API during the initial install, it can be enabled later.
1. (Optional) Enable [BlueBubbles Private API](https://docs.bluebubbles.app/private-api/installation)
1. Note: This requires disabling System Integrity Protection (SIP), which is not a wise thing to do on a Mac you use out in the world on a regular basis.
1. Not enabling Private API makes the following features unavailable:
1. "Tap Backs": aka Emoji Reactions
1. Please let us know if there's more you find that doesn't work...
1. Familiarize yourself with the [BlueBubbles API](https://documenter.getpostman.com/view/765844/UV5RnfwM#4e5fd735-bd88-41c1-bc8f-96394b91f5e6)

## Development
Expand All @@ -21,8 +24,10 @@
### Running Locally

1. Clone this repository: `git clone [email protected]:mautrix/imessage.git`
1. **TEMP**: Switch to the `bluebubbles` branch: `git checkout bluebubbles`
1. `cd` into `imessage`
1. Switch to the `bluebubbles` branch: `git checkout bluebubbles`
1. This is temporary while we're developing this feature.
1. You'll know you're in the right spot if you can see this README in your local code.
1. Run the following command to launch the bridge in development mode:

```bash
Expand All @@ -34,6 +39,13 @@ _NOTE_: Double check that the `config.yaml` that was automatically generated has
### Contributing

1. Find an open issue or bug
1. Create a fork or branch of this repository
1. Create and switch a fork of this repository and branch
1. Hack away
1. Submit a PR

#### Join us the community chat

1. In the Beeper Desktop App, click the Settings Gear (Cog) at the top
1. Add a server: `maunium.net`
1. Find the iMessage Room: `#imessage:maunium.net`
1. Say hello!

0 comments on commit 4305b25

Please sign in to comment.