GITBOOK-6: No subject

Author: ThatStella7922

docs/.gitbook/assets/image (20).png

@@ -6,12 +6,10 @@ Welcome to the documentation for Battery Webhook. To get started, tap the **Intr
 [introduction](docs/introduction/)
 {% endcontent-ref %}
 
-
-
 ### Looking for something else?
 
 * Battery Webhook on [ThatStella7922's Software site](https://software.thatstel.la/software/crossplatform-apps/battery-webhook)
 * Battery Webhook's [GitHub repository](https://github.com/ThatStella7922/battery-webhook)
 * Battery Webhook on [the App Store](https://apps.apple.com/us/app/battery-webhook/id6472404778)
 
-This documentation is for Battery Webhook 1.1.
+This documentation is for Battery Webhook 1.2.

docs/.gitbook/assets/image (24).png

@@ -6,18 +6,20 @@ description: What will Battery Webhook run on?
 
 Battery Webhook has been built from the ground up to take advantage of features available only in Apple's OSes, and requires one of these OSes at minimum:
 
+* macOS Ventura 13.0 or later
 * iOS 15.0 or later
 * iPadOS 15.0 or later
-* watchOS 8 or later
-* macOS Ventura 13.0 or later
+* watchOS 8.0 or later
+* visionOS 1.0 or later
 
 Additionally, Battery Webhook has some additional features only supported on more recent OS versions.
 
-* Siri Shortcuts support
-  * All macOS versions are supported
-  * iOS 16.0 or later is required
-  * iPadOS 16.0 or later is required
-  * watchOS 9.0 or later is required
+* **Siri Shortcuts** support requires:
+  * macOS Ventura 13.0 or later
+  * iOS 16.0 or later 
+  * iPadOS 16.0 or later
+  * watchOS 9.0 or later
+  * visionOS 1.0 or later
 
 ***
 

docs/.gitbook/assets/image (25).png

@@ -12,7 +12,7 @@ You'll notice that the **Settings** page in Battery Webhook has a few options we
 
 **Show specified avatar image** and **Show specified pronoun** control whether Battery Webhook will send the avatar image/pronoun to the webhook.
 
-**Send Device Name** and **Send Device Model** will control whether Battery Webhook will send your devices name/model to the webhook. These can be disabled if you would like greater privacy.
+**Send Device Name** and **Send Device Model** will control whether Battery Webhook will send your device's name/model to the webhook. These can be disabled if you would like greater privacy.
 
 ***
 

docs/.gitbook/assets/image (26).png

@@ -2,17 +2,27 @@
 
 ### macOS
 
-Battery Webhook uses IOPowerManagement events and IOKit queries to directly talk to your Mac's hardware, which provides _highly_ power-efficient and fast automations.
+Battery Webhook on macOS uses IOPowerManagement events and IOKit queries to directly talk to your Mac's hardware, which provides _highly_ power-efficient and fast automations.
 
 To take advantage of automations on macOS, just open the app and toggle the desired events in the **Automations** section.
 
 The automations will not be triggered if your configuration is invalid, so just ensure that it's valid before enabling them.
 
-<figure><img src="../../../.gitbook/assets/image (1).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../.gitbook/assets/image (26).png" alt=""><figcaption></figcaption></figure>
 
-### iOS and iPadOS
+Battery Webhook on macOS also supports launching itself when you log in, showing a Menu Bar Extra for quick and easy control, and hiding the main window + dock icon for a cleaner experience.
 
-Battery Webhook uses the Shortcuts Automations feature built into the Shortcuts app. As such, we add the **Send Battery Info** action to Shortcuts. This action depends on the app's configuration being valid, so ensure you've configured it properly before using the action.
+<figure><img src="../../../.gitbook/assets/image (27).png" alt=""><figcaption></figcaption></figure>
+
+Just head into **Settings**, scroll down and choose the options you'd like.
+
+{% hint style="success" %}
+Hiding the main window and dock icon + automatically launching Battery Webhook when logging in is **highly** recommended if you use automations.
+{% endhint %}
+
+### iOS, iPadOS and visionOS
+
+On these platforms, Battery Webhook uses the Shortcuts Automations feature built into the Shortcuts app. As such, we add the **Send Battery Info** action to Shortcuts. This action requires a valid configuration in the app.
 
 <figure><img src="../../../.gitbook/assets/image (15).png" alt="" width="375"><figcaption></figcaption></figure>
 
@@ -22,14 +32,26 @@ When set up with Shortcuts Automations, you can report battery info as seen on t
 
 <figure><img src="../../../.gitbook/assets/image (17).png" alt="" width="188"><figcaption></figcaption></figure>
 
-Let's get started setting it up. Open the **Shortcuts** app, then switch to the **Automations tab**. Tap **New Automation**, then open the **Charger** personal automation. Ensure it **Runs Immediately**, then tap **Next**. Tap **New Blank Automation** and add Battery Webhook's **Send Battery Info** action. Make sure to enable **Report that the device was plugged in** and that **Show When Run** is off.
+***
+
+Let's get started setting it up. Open the **Shortcuts** app, then switch to the **Automations tab**.
+
+Tap **New Automation**, then select the **Charger** personal automation. Make sure that **When** is set to "Is Connected", **Run Immediately** is selected and **Notify When Run** is turned off, then tap **Next**.\
+![](<../../../.gitbook/assets/image (24).png>)
+
+Tap **New Blank Automation** and add Battery Webhook's **Send Battery Info** action. Make sure to enable **Report that the device was plugged in** and that **Show When Run** is off, then press **Done** to create it.\
+![](<../../../.gitbook/assets/image (25).png>)
+
+For the next one, create another **Charger** personal automation. Ensure that **When** is _only_ set to "Is Disconnected", **Run Immediately** is checked and **Notify When Run** is turned off. Tap **Next**, add the **Send Battery Info** action, enable **Report that the device was unplugged** and disable **Show When Run**.
 
-For the next one, create another **Charger** personal automation, but ensure that **When** is _only_ set to **Is Disconnected**, and that **Run Immediately** is checked. Tap **Next**, add the **Send Battery Info** action and enable **Report that the device was unplugged** as well as disabling **Show When Run**.
+Last one. Create a **Battery Level** personal automation and change it to trigger at exactly **100%**. Again, ensure that **Runs Immediately** is checked and **Notify When Run** is turned off. Tap **Next** and add the **Send Battery Info** action, enable **Report that the device reached full charge** and disable **Show When Run**.
 
-Last one. Create a **Battery Level** personal automation and change it to trigger at exactly **100%**. Again, ensure it **Runs Immediately.** Tap **Next** and add the **Send Battery Info** action, then enable **Report that the device reached full charge** as well as disabling **Show When Run**.
+{% hint style="warning" %}
+If you forget to disable **Notify When Run** or **Show When Run** when setting up any of the above automations, you may see notifications on your device when plugging in, unplugging or fully charging your device. Disabling these means that no notifications will be shown.
+{% endhint %}
 
 Once you've set the automations up, they should appear like below:
 
 <figure><img src="../../../.gitbook/assets/image (19).png" alt="" width="375"><figcaption></figcaption></figure>
 
-At this point, plug in/unplug/let your device hit 100% and Battery Webhook will automatically send the batteyr info according to your configuration. If there's a configuration error, the Shortcuts app will let you know so you that can fix it in Battery Webhook
+At this point, plug in/unplug/let your device hit 100% and Battery Webhook will automatically send the batteyr info according to your configuration. If there's a configuration error, the Shortcuts app will let you know so you that can fix it in Battery Webhook.