Skip to content

Commit

Permalink
Readme (#1)
Browse files Browse the repository at this point in the history
* Update README.md

* workflow screenshots added

* Screenshots updated

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* more screenshots added

* Update README.md

* Update README.md

* Update README.md

* More screenshots added

* Update README.md

* Screenshot updated

* Version updated
  • Loading branch information
vookimedlo authored Nov 28, 2017
1 parent 7aecbbf commit 97520c4
Show file tree
Hide file tree
Showing 7 changed files with 51 additions and 4 deletions.
49 changes: 48 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,49 @@
# alfred-various-screenshots
Alfred 3 plugin for taking various screenshots.
[Alfred 3][1] workflow for taking various screenshots.

## Installation
1) Install [alfred-various-screenshots][2] wokflow.
2) All further updates are handled automatically.

## Usage
In Alfred, type `ss`, which stands for ScreenShot and initiates a submenu which offers three options.

1) Screenshot - Area
2) Screenshot - Screen
3) Screenshot - Window

![Alfred menu screenshot](doc/images/alfred-various-screenshots.png?raw=true "")
![Alfred submenu screenshot](doc/images/alfred-various-screenshots-submenu.png?raw=true "")


By default, the screenshot is stored in a file located at your `~/Desktop` directory.
This could be overriden, either by pressing the <kbd>⌘</kbd> key, or <kbd>⌥</kbd> key.

The first one - <key>⌘</key> - instructs workflow to put a screenshot to clipboard.
The second one - <key>⌥</key> - shares a screenshots via Dropbox and stores a sharing link to clipboard.

Screenshots files will be named according to the following pattern `screenshot_%Y-%m-%d_%H-%M-%S.png`

Y Year in full form (e.g., 2006).
m Numeric month, a number from 1 to 12.
d Day, a number from 1 to 31.
H Hour, a number from 0 to 23.
M Minutes, a number from 0 to 59.
S Seconds, a number from 0 to 59.
### Dropbox
There is no need to install a Dropbox software to you MacOS. The only requirement is to log into the [web Dropbox account][3] and create an access token for the workflow.

![Dropbox App Creation](doc/images/dropbox-app-create.png?raw=true "")

------------------------------

![Dropbox App Key Creation](doc/images/dropbox-app-key.png?raw=true "")

Such generated access token shall be placed to the workflow `DropboxAccessToken` variable.

![Alfre Variable](doc/images/alfred-various-screenshots-variable.png?raw=true "")

[1]: https://www.alfredapp.com/
[2]: https://github.com/vookimedlo/alfred-various-screenshots/releases/latest
[3]: https://www.dropbox.com/developers/apps
Binary file modified doc/images/alfred-various-screenshots-submenu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/images/alfred-various-screenshots.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/dropbox-app-create.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/dropbox-app-key.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions src/info.plist
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@ fi</string>
<key>removeextension</key>
<false/>
<key>text</key>
<string>check your clipboard {query}</string>
<string>check your clipboard</string>
<key>title</key>
<string>Screenshot taken</string>
</dict>
Expand Down Expand Up @@ -500,7 +500,7 @@ fi</string>
<key>removeextension</key>
<false/>
<key>text</key>
<string>configure workflow to have correct access token</string>
<string>configure workflow to have a correct access token</string>
<key>title</key>
<string>Dropbox access token is missing</string>
</dict>
Expand Down Expand Up @@ -851,7 +851,7 @@ fi</string>
<string>DropboxAccessToken</string>
</array>
<key>version</key>
<string>2017.11.14</string>
<string>2017.11.28</string>
<key>webaddress</key>
<string>https://github.com/vookimedlo/alfred-various-screenshots</string>
</dict>
Expand Down

0 comments on commit 97520c4

Please sign in to comment.