1
0
mirror of https://github.com/Toxblh/MTMR.git synced 2026-01-11 09:28:38 +00:00

update Readme

This commit is contained in:
Toxblh 2018-04-21 00:23:48 +01:00
parent 7874433d9b
commit 9b86ed1dee

View File

@ -46,7 +46,6 @@ Maybe:
## Installation ## Installation
1. Download last release [Releases](https://github.com/Toxblh/MTMR/releases) 1. Download last release [Releases](https://github.com/Toxblh/MTMR/releases)
2. Unzip
3. Open MTMR 3. Open MTMR
4. Open preset `open ~/Library/Application\ Support/MTMR/items.json` and customize it. Restart MTMR to apply changes. 4. Open preset `open ~/Library/Application\ Support/MTMR/items.json` and customize it. Restart MTMR to apply changes.
@ -62,16 +61,20 @@ File for customize your preset for MTMR: `open ~/Library/Application\ Support/MT
- brightnessDown - brightnessDown
- volumeDown - volumeDown
- volumeUp - volumeUp
- mute
- dock - dock
> Native Plugins
- battery
- currency
- weather
> Media Keys > Media Keys
- previous - previous
- play - play
- next - next
> AppleScript plugins > AppleScript plugins
- weather
- battery
- sleep - sleep
- displaySleep - displaySleep
@ -106,8 +109,28 @@ File for customize your preset for MTMR: `open ~/Library/Application\ Support/MT
"formatTemplate": "HH:mm" //optional "formatTemplate": "HH:mm" //optional
``` ```
## Native plugins
- `weather`
> Provider: https://openweathermap.org Need allowance location service
```js
"type": "weather",
"refreshInterval": 600,
"units": "metric", // or imperial
```
- `currency`
> Provider: https://coinbase.com
```js
"type": "currency",
"refreshInterval": 600,
"align": "right",
"from": "BTC",
"to": "USD",
```
## Actions: ## Actions:
- `hidKey` - `hidKey`
> https://github.com/aosm/IOHIDFamily/blob/master/IOHIDSystem/IOKit/hidsystem/ev_keymap.h use only numbers
```json ```json
"action": "hidKey", "action": "hidKey",
"keycode": 53, "keycode": 53,
@ -132,10 +155,16 @@ File for customize your preset for MTMR: `open ~/Library/Application\ Support/MT
```js ```js
"action": "shellScript", "action": "shellScript",
"executablePath": "/usr/bin/pmset", "executablePath": "/usr/bin/pmset",
"shellArguments": "sleepnow", // optional "shellArguments": ["sleepnow"], // optional
``` ```
- `openUrl`
```js
"action": "openUrl",
"url": "https://google.com",
```
## Additional paramaters: ## Additional paramaters:
- `width` allow to restrict how much room a particular button will take - `width` allow to restrict how much room a particular button will take