mirror of
https://github.com/syncthing/syncthing-macos.git
synced 2026-06-16 12:04:33 +00:00
Update README.md
This commit is contained in:
@@ -2,18 +2,44 @@
|
||||
|
||||
[](https://paypal.me/xorgate) [](https://github.com/xor-gate/syncthing-macosx/releases) [](https://github.com/xor-gate/syncthing-macosx/releases/latest) [](https://travis-ci.org/xor-gate/syncthing-macosx) [](LICENSE)
|
||||
|
||||
Native systray application for Mac OS X 10.10 and higher.
|
||||
|
||||
* Shows syncthing icon status (connected/not-connected)
|
||||
* Tray menu
|
||||
* Open syncthing web-gui
|
||||
* Preferences pane
|
||||
* URI
|
||||
* API-key
|
||||
* Quit application and syncthing instance
|
||||
* Shows systray tooltip
|
||||
* Current (connection) state
|
||||
* Current connection URI to syncthing
|
||||
* Current uptime (in seconds) (needs human readable conversion).
|
||||
|
||||
# Why
|
||||
|
||||
I wrote this in a weekend because all the cross-platform approaches didn't worked well natively. The application is functional and needs further testing. I run it daily.
|
||||
|
||||
# Build
|
||||
|
||||
Build with XCode or run:
|
||||
|
||||
```
|
||||
xcodebuild
|
||||
```
|
||||
|
||||
It will automaticly download syncthing amd64 binary and add it to the Application. The fancy
|
||||
DMG is also created automaticly.
|
||||
|
||||
# Syncthing ApiKey
|
||||
|
||||
Fetch your current API key and load it into the prefences and restart the tray.
|
||||
You need to configure your API key in the preferences dialog as the application only starts a syncthing instance
|
||||
and a system tray. You can fetch your current API key:
|
||||
|
||||
`sed -n 's:.*<apikey>\(.*\)</apikey>.*:\1:p' $HOME/Library/Application\ Support/Syncthing/config.xml`
|
||||
|
||||
You must restart the application to work (for now).
|
||||
|
||||
# Configuration and defaults
|
||||
|
||||
Writing defaults is handled by OS X and can be set from the GUI or console.
|
||||
@@ -36,6 +62,10 @@ defaults write com.github.xor-gate.syncthing-macosx ApiKey 1234
|
||||
I'm trying to create a native Objective-C library to access Syncthing REST API.
|
||||
See [`XGSyncthing.h`](syncthing/XGSyncthing.h).
|
||||
|
||||
# Contributions
|
||||
|
||||
I appreciate code and project contributions and possible bugs which you can be opened in the issue tracker.
|
||||
|
||||
# License
|
||||
|
||||
[MIT](LICENSE)
|
||||
|
||||
Reference in New Issue
Block a user