Skip to content

Commit

Permalink
Merge pull request #76 from botantony/safari-readme
Browse files Browse the repository at this point in the history
Update README for Safari extension
  • Loading branch information
Abdallah-Alwarawreh authored Jan 8, 2025
2 parents b2da8c3 + a3af33b commit 02aebb5
Showing 1 changed file with 14 additions and 10 deletions.
24 changes: 14 additions & 10 deletions Extension-Safari/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,25 @@
1. **Download the Extension**:
Clone or download the repo: `git clone https://github.com/Abdallah-Alwarawreh/Syrup.git`

2. Open the `Extension-Safari` directory and run `Syrup.xcodeproj`
2. Build the main project by running `npm install && npm run build` in `Extension-React` directory

- Additionally you might need to run this command with root privileges. If the previous command failed just run `sudo !!`

3. Open the `Extension-Safari` directory and run `Syrup.xcodeproj`

## 🚀 Installation (Locally Only)

3. Ensure at the top of Xcode you see `Syrup (macOS)`
4. Ensure at the top of Xcode you see `Syrup (macOS)`

4. On the left sidebar select Syrup
5. On the left sidebar select Syrup

5. Go to the `Signing & Capabilities` tab and you should see 4 "targets" on the left side
6. Go to the `Signing & Capabilities` tab and you should see 4 "targets" on the left side

- Go through each of the targets and set the `Team` as your Apple ID's "Personal Team" and `Signing Certificate` to `Development`

6. Click the play button at the top left and it should build and open the macOS app
7. Click the play button at the top left and it should build and open the macOS app

7. If you would like to use the extension on iOS:
8. If you would like to use the extension on iOS:
- [iPhone] Open the settings app then go into Privacy & Security > Developer Mode and ensure it is enabled
- Connect your iPhone to your macOS device via USB
- [macOS] At the top of Xcode switch "Syrup (macOS)" to "Syrup (iOS)"
Expand All @@ -35,10 +39,10 @@

## 🚀 Installation (To Publish)

3. Ensure at the top of Xcode you see `Syrup (macOS)`
4. Ensure at the top of Xcode you see `Syrup (macOS)`

4. On the menu bar click `Product` then `Archive`
5. On the menu bar click `Product` then `Archive`

5. Once the `Archives` menu shows up click the `Distribute App` option on the right
6. Once the `Archives` menu shows up click the `Distribute App` option on the right

6. The only option that works without a paid apple developer account is `Custom` > `Copy App` however I'm unsure if that would work if you share the `Syrup.app` to other people since it wouldn't be signed for them.
7. The only option that works without a paid apple developer account is `Custom` > `Copy App` however I'm unsure if that would work if you share the `Syrup.app` to other people since it wouldn't be signed for them.

0 comments on commit 02aebb5

Please sign in to comment.