diff --git a/ReadMe.md b/ReadMe.md index af10462..fdd17a7 100644 --- a/ReadMe.md +++ b/ReadMe.md @@ -21,7 +21,7 @@ Sponsor Ebullioscopic - + Download Atoll for macOS @@ -39,85 +39,26 @@ Atoll turns the MacBook notch into a focused command surface for media, system insight, and quick utilities. It stays out of the way until needed, then expands with responsive, native SwiftUI animations. -## UI Modes - -### Minimalistic Mode -- Compact layout focused on core actions and quick glance info. -- Ideal when you want media and essentials without wider panels. -

- Minimalistic UI + Atoll preview

-### Standard Mode -- Full-width experience with richer layouts, panels, and context. -- Best for deep control of media, stats, and productivity tools. - -

- Standard UI -

- -## Calendar & Reminders -- Clean calendar panel with upcoming events and reminders. -- Efficient EventKit usage to minimise refreshes and background churn. -- Clear timeline of upcoming items; grants only when you approve Calendar access. - -

- Calendar and reminders -

- -## Timers -- Named timers with live activity state, clear progress, and alerts. -- Choose circular ring or linear bar; pick tints that match your setup. -- Controls live both in the notch and via menu bar for quick access. - -

- Timers -

- -## Do Not Disturb -- One-tap Focus toggle with immediate visual feedback near the notch. -- See current status at a glance without digging through menus. - -

- Do Not Disturb -

- -## Lock Screen Widgets -- Media playback controls with artwork and transport. -- Active timer progress with visual feedback. -- Device charging status and battery levels. -- Connected Bluetooth devices and their battery states. -- Current weather conditions and forecast. - -

- Do Not Disturb -

- -## Live Activities - -- Media Playback -- Focus Mode -- Screen Recording -- Microphone, Camera Privacy Indicators -- Connected Bluetooth Devices -- Download progress `beta` -- Low Battery status, Charging - -## Overview +## Highlights - Media controls for Apple Music, Spotify, and more with inline previews. -- Live system insight (CPU, GPU, memory, network, disk) with lightweight graphs. -- Productivity tools: clipboard history, colour picker, timers, calendar. -- Optional minimalistic layout for a compact 420px notch footprint. +- Live Activities for media playback, Focus, screen recording, privacy indicators, downloads (beta), and battery/charging. +- Lock screen widgets for media, timers, charging, Bluetooth devices, and weather. +- Lightweight system insight for CPU, GPU, memory, network, and disk usage. +- Productivity tools including timers, clipboard history, color picker, and calendar previews. +- Customization for layouts, animations, hover behavior, and shortcut remapping. -## Features -- Media: artwork and transport controls, inline sneak-peek, adaptive lighting that subtly echoes album colours. -- System: lightweight CPU/GPU/memory/network/disk graphs; drill into quick popovers when you need details. -- Productivity: rich timers with live activity, precise colour picker with formats, and a searchable clipboard history. -- Calendar: streamlined agenda with snapshot-driven updates to keep EventKit usage lean. -- Lock Screen: weather, media, charging, and Bluetooth battery widgets that respect system accessory styles. -- Parallax interactions: hover tilt now stays responsive while clicks fire immediately, and the lock screen album art suspends the effect mid-animation for smooth expansions. -- Customisation: minimalistic/standard layouts, animation styles, hover behaviour, and full shortcut remapping. +## Other Features +- Gesture controls for opening/closing the notch and media navigation. +- Parallax hover interactions with smooth transitions. +- Lock screen appearance and positioning controls for panels and widgets. + +

+ Atoll lock screen +

## Requirements - macOS 14.0 or later (optimised for macOS 15+). @@ -126,19 +67,14 @@ Atoll turns the MacBook notch into a focused command surface for media, system i - Permissions as needed: Accessibility, Camera, Calendar, Screen Recording, Music. ## Installation -1) Clone and open the project -```bash -git clone https://github.com/Ebullioscopic/Atoll.git -cd Atoll -open DynamicIsland.xcodeproj -``` -2) Select your Mac as the run destination, then build and run (⌘R). -3) Grant prompted permissions. The menu bar icon appears and the notch activates on hover. +1) Download the latest DMG: https://github.com/Ebullioscopic/Atoll/releases/download/v1.3.0-beta/Atoll.1.3.0-beta.dmg +2) Open the DMG and drag Atoll into Applications. +3) Launch Atoll and grant the requested permissions. ## Quick Start - Hover near the notch to expand; click to enter controls. - Use tabs for Media, Stats, Timers, Clipboard, and more. -- Toggle Minimalistic Mode from Settings for a smaller layout. +- Adjust layout, appearance, and shortcuts from Settings. ## Settings - Choose appearance, animation style, and per‑feature toggles. @@ -205,4 +141,12 @@ A heartfelt thanks to [TheBoredTeam](https://github.com/TheBoredTeam) for being Powered by Apple and Infosys
SRM Institute of Science and Technology, Chennai, India +

+ +

+ Buy Me A Coffee +

+ +

+ Your support helps fund teaching children software development.

\ No newline at end of file