yeahitsjan / WiredBuddy

the missing icon for ethernet interfaces, but cool 😎
MIT License
111 stars 0 forks source link
ethernet interface macos macos-app menubar network productivity swift swiftui utility

Wired Buddy

macOS lang license downloads

A small friendly buddy living on the macOS menu bar, showing the current state of an active ethernet interface.

active

:rocket: Installation

Compatible with macOS 13 or later due to use of MenuBarExtra and LaunchAtLogin-Modern

You can grab the latest version from the releases page. Unzip it and copy it to the Applications folder. Have fun! :relaxed:

Due to local signing, you probably need to run the application again from settings, allowing its execution. In #3 and #4 you can see how this probably looks. The reason for this is described in this comment.

There will a brew cask in the near future, stay tuned!

:hammer: Compiling

$ git clone https://github.com/yeahitsjan/WiredBuddy.git

Open up Wired Buddy.xcodeproj in Xcode. Some packages will be fetched so let Xcode finish all its tasks, before you hit build!

If you encounter signing issues, you could take a look into 🐛 Self compiling, where there is a pretty good description how to sign the application on your own.

:airplane: Roadmap

Wired Buddy's main features (displaying the active state of an ethernet connection) are already fully functional (bugs inside™). Still there is something to do before releasing a stable v1.0:

If you want to support localizing the app, take a look into the en.lproj, copy its contents. Translate the strings on the right side into your language and open up an issue with an attached text file of your translated strings. You will surely be mentioned in the AboutView of Wired Buddy! :relaxed:

:heart: Show some love!

You love Wired Buddy? Want to say thank you or just donate something to it's development? You can tip me something, if you want to and get your name into the app :relaxed:

License

Wired Buddy itself uses MacControlCenterUI, MenuBarExtraAccess, SettingsAccess and LaunchAtLogin-Modern to achieve its native-like look n' feel. Visit these awesome repositories for more informations on their licenses :heart:

Wired Buddy is licensed under the MIT license.

MIT License

Copyright (c) 2024 Jan Kowalewicz <jan (at) nitroosit (dot) de>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.