Skip to content

Commit 4557756

Browse files
the0neyouseekthe0neyouseek
committed
🐛 Fix Readme errors
Signed-off-by: Guillaume Broder <[email protected]>
1 parent 036a29d commit 4557756

File tree

2 files changed

+133
-5
lines changed

2 files changed

+133
-5
lines changed

‎.github/rules.json‎

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
{
2+
"title": "MonitorControl (@the0neyouseek)",
3+
"rules": [
4+
{
5+
"description": "External Screen brightness [-] (using MonitorControl)",
6+
"manipulators": [{
7+
"type": "basic",
8+
"from": {
9+
"key_code": "f1",
10+
"modifiers": {
11+
"optional": [
12+
"any"
13+
]
14+
}
15+
},
16+
"to": [{
17+
"key_code": "down_arrow",
18+
"modifiers": [
19+
"left_shift",
20+
"left_control",
21+
"left_option",
22+
"left_command"
23+
]
24+
}]
25+
}]
26+
},
27+
{
28+
"description": "External Screen brightness [+] (using MonitorControl)",
29+
"manipulators": [{
30+
"type": "basic",
31+
"from": {
32+
"key_code": "f2",
33+
"modifiers": {
34+
"optional": [
35+
"any"
36+
]
37+
}
38+
},
39+
"to": [{
40+
"key_code": "up_arrow",
41+
"modifiers": [
42+
"left_shift",
43+
"left_control",
44+
"left_option",
45+
"left_command"
46+
]
47+
}]
48+
}]
49+
},
50+
{
51+
"description": "External Screen volume [-] (using MonitorControl)",
52+
"manipulators": [{
53+
"type": "basic",
54+
"from": {
55+
"key_code": "f11",
56+
"modifiers": {
57+
"optional": [
58+
"any"
59+
]
60+
}
61+
},
62+
"to": [{
63+
"key_code": "left_arrow",
64+
"modifiers": [
65+
"left_shift",
66+
"left_control",
67+
"left_option",
68+
"left_command"
69+
]
70+
}]
71+
}]
72+
},
73+
{
74+
"description": "External Screen volume [+] (using MonitorControl)",
75+
"manipulators": [{
76+
"type": "basic",
77+
"from": {
78+
"key_code": "f12",
79+
"modifiers": {
80+
"optional": [
81+
"any"
82+
]
83+
}
84+
},
85+
"to": [{
86+
"key_code": "right_arrow",
87+
"modifiers": [
88+
"left_shift",
89+
"left_control",
90+
"left_option",
91+
"left_command"
92+
]
93+
}]
94+
}]
95+
},
96+
{
97+
"description": "External Screen volume mute (using MonitorControl)",
98+
"manipulators": [{
99+
"type": "basic",
100+
"from": {
101+
"key_code": "f10",
102+
"modifiers": {
103+
"optional": [
104+
"any"
105+
]
106+
}
107+
},
108+
"to": [{
109+
"key_code": "equal_sign",
110+
"modifiers": [
111+
"left_shift",
112+
"left_control",
113+
"left_option",
114+
"left_command"
115+
]
116+
}]
117+
}]
118+
}
119+
]
120+
}

‎README.md‎

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,17 @@ Control your external monitor brightness, contrast or volume directly from a men
1212

1313
## Download
1414

15-
Go to [Release](./) and download the latest `.dmg`
15+
Go to [Release](https://github.com/the0neyouseek/MonitorControl/releases/latest) and download the latest `.dmg`
1616

1717
## Brightness/Volume default key
18-
You can use [Karabiner Elements](https://github.com/tekezo/Karabiner-Elements/) to use the default mac key (`F1`, `F2` for brightness and `F10`, `F11`, `F12` for volume) with this set of custom rules : [Karabiner rules for MonitorControl](karabiner://karabiner/assets/complex_modifications/import?url=https%3A%2F%2Fraw.githubusercontent.com%2Fthe0neyouseek%2FMonitorControl%2Fmaster%2F.github%2Frules.json)
18+
You can use [Karabiner Elements](https://github.com/tekezo/Karabiner-Elements/) to use the default mac key (`F1`, `F2` for brightness and `F10`, `F11`, `F12` for volume) with this set of custom rules :
19+
[Karabiner rules for MonitorControl](./.github/rules.json)
20+
21+
Copy and paste this url in your browser to install them directly :
22+
23+
```
24+
karabiner://karabiner/assets/complex_modifications/import?url=https%3A%2F%2Fraw.githubusercontent.com%2Fthe0neyouseek%2FMonitorControl%2Fmaster%2F.github%2Frules.json
25+
```
1926

2027
---
2128

@@ -29,12 +36,13 @@ Bonus: Using keyboard shortcuts display the native osd :
2936
- [ ] Skip Karabiner use for keyboard shortcut
3037
- [ ] Option to start app at login
3138
- [ ] Add [SwiftLint](https://github.com/realm/SwiftLint)
39+
- [ ] Change App Icon
3240

3341
## Support
3442
- macOS Sierra (`10.12`) and up.
3543
- Works with monitors comptaible with [@kfix/ddcctl](https://github.com/kfix/ddcctl)
3644

3745
## Thanks
38-
- @bluejamesbond (Original developer)
39-
- @Tyilo (Fork)
40-
- @Bensge - (Used some code from his project [NativeDisplayBrightness](https://github.com/Bensge/NativeDisplayBrightness))
46+
- [@bluejamesbond](https://github.com/bluejamesbond/) (Original developer)
47+
- [@Tyilo](https://github.com/Tyilo/) (Fork)
48+
- [@Bensge](https://github.com/Bensge/) - (Used some code from his project [NativeDisplayBrightness](https://github.com/Bensge/NativeDisplayBrightness))

0 commit comments

Comments
 (0)