Skip to content

Commit 7f16f87

Browse files
committed
docs: Use upgit with AHK
1 parent c0856e3 commit 7f16f87

File tree

1 file changed

+35
-5
lines changed

1 file changed

+35
-5
lines changed

README.md

Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ![upgit](https://github.com/pluveto/upgit/blob/main/logo.png?raw=true)
1+
# ![upgit](https://cdn.jsdelivr.net/gh/pluveto/upgit/logo.png)
22

33
*Upgit* helps you simply upload any file to your Github repository and then get a raw URL for it.
44

@@ -91,13 +91,13 @@ Move to *Image*. Choose *Custom Command* as your *Image Uploader*.
9191

9292
Input *upgit* program location into *Command* textbox.
9393

94-
Now enjoy it.
95-
9694
> You can click *Test Uploader* button to make sure it works.
9795
9896
![image-20220128204418723](https://cdn.jsdelivr.net/gh/pluveto/0images@master/2022/01/upgit_20220128_1643373868.png)
9997

100-
## Upload Clipboard
98+
Now enjoy it!
99+
100+
### Upload Clipboard
101101

102102
Use `:clipboard` place holder for clipboard image. (Only supports **png** format)
103103

@@ -111,11 +111,41 @@ Shortcuts for screenshot:
111111
- On Linux/Ubuntu, use `Ctrl+Shift+PrintScreen`
112112
- On Windows, use `Shift+Win+s`
113113

114+
### Save URL to Clipboard
114115

116+
Use `--output-type clipboard-markdown`:
115117

116-
## Config Instructions
118+
```shell
119+
./upgit logo.png --output-type clipboard-markdown
120+
# or ./upgit :clipboard --o clipboard-markdown
121+
```
122+
123+
Then you'll get a markdown image link in your clipboard like:
117124

125+
```
126+
![logo.png](!https://cdn.jsdelivr.net/gh/pluveto/upgit/logo.png)
127+
```
118128

129+
### Best practice with AHK
130+
131+
For Windows user:
132+
133+
1. Install AHK
134+
135+
2. Create this script `upload_clipboard.ahk` and run:
136+
137+
```ahk
138+
# Ctrl+F9 As shortcut
139+
^F9::
140+
RunWait, explorer ms-screenclip:
141+
# use your own *upgit* program path
142+
RunWait, "upgit.exe" :clipboard --output-type clipboard-markdown
143+
return
144+
```
145+
146+
3. Then press <kbd>Ctrl</kbd><kbd>F9</kbd> to automatically take screenshot, upload it and get its link to your clipboard!
147+
148+
## Config Instructions
119149

120150
| Key | Desc |
121151
| --------------------- | ------------------------------------------------------------ |

0 commit comments

Comments
 (0)