Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hpcreery committed Aug 31, 2022
1 parent 10cc201 commit 9eda67b
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,30 @@

# MacOS Wobbly Windows

[![npm downloads](https://badgen.net/badge/platform/macOS?icon=apple&label&color=blac)](https://www.apple.com/macos)
[![npm version](https://badgen.net/github/stars/hpcreery/MacOSWobblyWindows?color=blac&icon=github&label=stars)](https://github.com/hpcreery/MacOSWobblyWindows)
[![npm downloads](https://badgen.net/github/last-commit/hpcreery/MacOSWobblyWindows?color=blac&icon=git)](https://github.com/hpcreery/MacOSWobblyWindows/commits/master)


A wobbly windows implementation for MacOS inspired by [Compiz-Fusion](https://compiz-fusion.org/wiki_subdomain/plugins/wobbly.html) for Linux.

<sup>*Note: this is only a proof of concept*</sup>

![MacOS WobblyWindow Logo](./Resources/DesktopWobblyWindows.gif)

## Usage
## 🖥 Usage

- Install SIMBL loader like using [mySIMBL](https://github.com/w0lfschild/mySIMBL) or [MacForge](https://www.macenhance.com/macforge). Note that you currently need to disable System Integrity Protection (SIP) in order for this to work.
- Download the [latest bundle](https://github.com/iamDecode/Jello/releases), or build it yourself (see Building).
- Drag bundle onto the app to enable it.
- Restart apps for WobblyWindows to take effect.


## Building
## 🛠 Building

The Xcode project contains two targets, `WobblyWindows` will run a sample window with wobble logic enabled, `WobblyWindowsInject` builds a bundle that can be used with a SIMBL loader.


## Contributing
## 🖋 Contributing

Feel free to make a contribution. Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on the code of conduct, and the process for submitting pull requests.

0 comments on commit 9eda67b

Please sign in to comment.