Skip to content

Commit 0f1eb51

Browse files
pforretpforret
committed
update README
1 parent ca6d05a commit 0f1eb51

1 file changed

Lines changed: 51 additions & 52 deletions

File tree

‎README.md‎

Lines changed: 51 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -24,67 +24,66 @@ Works with
2424
## Usage
2525

2626
```
27-
Program: splashmark 2.4.2 created on 2020-09-28 by peter@forret.com
28-
Updated: Feb 17 10:45:58 2021
29-
Usage: splashmark [-h] [-q] [-v] [-l <log_dir>] [-t <tmp_dir>]
30-
[-1 <northwest>] [-2 <northeast>] [-3 <southwest>] [-4 <southeast>]
31-
[-w <width>] [-c <crop>] [-e <effect>] [-g <gravity>] [-m <margin>]
32-
[-i <title>] [-z <titlesize>] [-k <subtitle>] [-j <subtitlesize>]
33-
[-o <fontsize>] [-p <fonttype>] [-r <fontcolor>]
34-
[-x <photographer>] [-u <url>] [-d <randomize>]
35-
[-U <UNSPLASH_ACCESSKEY>]
36-
<action> <output> <input>
27+
Program: splashmark 3.0.0 by peter@forret.com
28+
Updated: Apr 20 22:27:45 2021
29+
Description: package_description
30+
Usage: splashmark [-h] [-q] [-v] [-l <log_dir>] [-t <tmp_dir>] [-w <width>] [-c <crop>] [-1 <northwest>] [-2 <northeast>] [-3 <southwest>] [-4 <southeast>] [-d <randomize>] [-e <effect>] [-g <gravity>] [-i <title>] [-z <titlesize>] [-k <subtitle>] [-j <subtitlesize>] [-m <margin>] [-o <fontsize>] [-p <fonttype>] [-r <fontcolor>] [-x <photographer>] [-u <url>] [-P <PIXABAY_ACCESSKEY>] [-U <UNSPLASH_ACCESSKEY>] <action> <input?> <output?>
3731
Flags, options and parameters:
38-
-h|--help : [flag] show usage [default: off]
39-
-q|--quiet : [flag] no output [default: off]
40-
-v|--verbose : [flag] output more [default: off]
41-
-l|--log_dir <val>: [optn] folder for debug files [default: /Users/pforret/log/splashmark]
42-
-t|--tmp_dir <val>: [optn] folder for temp files [default: .tmp]
43-
-1|--northwest <val>: [optn] text to put in left top
44-
-2|--northeast <val>: [optn] text to put in right top [default: {url}]
45-
-3|--southwest <val>: [optn] text to put in left bottom [default: Created with pforret/splashmark]
46-
-4|--southeast <val>: [optn] text to put in right bottom [default: {copyright2}]
47-
-w|--width <val>: [optn] image width for resizing [default: 1200]
48-
-c|--crop <val>: [optn] image height for cropping [default: 0]
49-
-e|--effect <val>: [optn] use effect chain on image: bw/blur/dark/grain/light/median/paint/pixel
50-
-g|--gravity <val>: [optn] title alignment left/center/right [default: center]
51-
-m|--margin <val>: [optn] margin for watermarks [default: 30]
52-
-i|--title <val>: [optn] big text to put in center
53-
-z|--titlesize <val>: [optn] font size for title [default: 80]
54-
-k|--subtitle <val>: [optn] big text to put in center
55-
-j|--subtitlesize <val>: [optn] font size for subtitle [default: 50]
56-
-o|--fontsize <val>: [optn] font size for watermarks [default: 15]
57-
-p|--fonttype <val>: [optn] font type family to use [default: FiraSansExtraCondensed-Bold.ttf]
58-
-r|--fontcolor <val>: [optn] font color to use [default: FFFFFF]
59-
-x|--photographer <val>: [optn] photographer name (empty: get from Unsplash)
60-
-u|--url <val>: [optn] photo URL override (empty: get from Unsplash)
61-
-d|--randomize <val>: [optn] take a random picture in the first N results [default: 1]
62-
-U|--UNSPLASH_ACCESSKEY <val>: [optn] Unsplash access key
63-
<action> : [parameter] action to perform: download/search/file/url
64-
<output> : [parameters] output file (1 or more)
65-
<input> : [parameters] URL or search term (1 or more)
66-
67-
32+
-h|--help : [flag] show usage [default: off]
33+
-q|--quiet : [flag] no output [default: off]
34+
-v|--verbose : [flag] output more [default: off]
35+
-l|--log_dir <?> : [option] folder for log files [default: /Users/pforret/log/splashmark]
36+
-t|--tmp_dir <?> : [option] folder for temp files [default: /tmp/splashmark]
37+
-w|--width <?> : [option] image width for resizing [default: 1200]
38+
-c|--crop <?> : [option] image height for cropping [default: 0]
39+
-1|--northwest <?>: [option] text to put in left top
40+
-2|--northeast <?>: [option] text to put in right top [default: {url}]
41+
-3|--southwest <?>: [option] text to put in left bottom [default: Created with pforret/splashmark]
42+
-4|--southeast <?>: [option] text to put in right bottom [default: {copyright2}]
43+
-d|--randomize <?>: [option] take a random picture in the first N results [default: 1]
44+
-e|--effect <?> : [option] use effect chain on image: bw/blur/dark/grain/light/median/paint/pixel
45+
-g|--gravity <?> : [option] title alignment left/center/right [default: center]
46+
-i|--title <?> : [option] big text to put in center
47+
-z|--titlesize <?>: [option] font size for title [default: 80]
48+
-k|--subtitle <?>: [option] big text to put in center
49+
-j|--subtitlesize <?>: [option] font size for subtitle [default: 50]
50+
-m|--margin <?> : [option] margin for watermarks [default: 30]
51+
-o|--fontsize <?>: [option] font size for watermarks [default: 15]
52+
-p|--fonttype <?>: [option] font type family to use [default: FiraSansExtraCondensed-Bold.ttf]
53+
-r|--fontcolor <?>: [option] font color to use [default: FFFFFF]
54+
-x|--photographer <?>: [option] photographer name (empty: use name from API)
55+
-u|--url <?> : [option] photo URL override (empty: use URL from API)
56+
-P|--PIXABAY_ACCESSKEY <?>: [option] Pixabay access key
57+
-U|--UNSPLASH_ACCESSKEY <?>: [option] Unsplash access key
58+
<action> : [parameter] action to perform: unsplash/file/url
59+
<input> : [parameter] URL or search term (optional)
60+
<output> : [parameter] output file (optional)
61+
@github.com:pforret/splashmark.git
6862
### TIPS & EXAMPLES
69-
* use splashmark download to download a specific Unsplash photo and work with it (requires free Unsplash API key)
70-
splashmark download splash.jpg "https://unsplash.com/photos/xWOTojs1eg4"
71-
splashmark -i "The Title" -k "The subtitle" download output.jpg "https://unsplash.com/photos/xWOTojs1eg4"
72-
splashmark -i "Splash" -k "Subtitle" -w 1280 -c 640 -e dark,grain download output.jpg "https://unsplash.com/photos/xWOTojs1eg4"
73-
* use splashmark search to search for a keyword on Unsplash and take the Nth photo (requires free Unsplash API key)
74-
splashmark search waterfall.jpg waterfall
75-
splashmark --randomize --title "Splash" --subtitle "Subtitle" --width 1280 --crop 640 --effect dark,grain search waterfall.jpg waterfall
63+
* use splashmark unsplash to download or search a Unsplash photo (requires free Unsplash API key)
64+
splashmark unsplash "https://unsplash.com/photos/lGo_E2XonWY" rose.jpg
65+
splashmark unsplash rose rose.jpg
66+
splashmark unsplash rose (will generate unsplash.rose.jpg)
67+
* use splashmark pixabay to download or search a Pixabay photo (requires free Pixabay API key)
68+
splashmark pixabay "https://pixabay.com/photos/rose-flower-love-romance-beautiful-729509/" rose.jpg
69+
splashmark pixabay rose rose.jpg
70+
splashmark pixabay rose (will generate pixabay.rose.jpg)
7671
* use splashmark file to add texts and effects to a existing image
7772
splashmark file waterfall.jpg sources/original.jpg
78-
splashmark --title "Strawberry" -w 1280 -c 640 -e dark,median,grain file waterfall.jpg sources/original.jpg
73+
splashmark --title "Strawberry" -w 1280 -c 640 -e dark,median,grain file sources/original.jpg waterfall.jpg
7974
* use splashmark url to add texts and effects to a image that will be downloaded from a URL
8075
splashmark file waterfall.jpg "https://i.imgur.com/rbXZcVH.jpg"
81-
splashmark -w 1280 -c 640 -4 "Photographer: John Doe" -e dark,median,grain url waterfall.jpg "https://i.imgur.com/rbXZcVH.jpg"
76+
splashmark -w 1280 -c 640 -4 "Photographer: John Doe" -e dark,median,grain url "https://i.imgur.com/rbXZcVH.jpg" waterfall.jpg
77+
* use splashmark check to check if this script is ready to execute and what values the options/flags are
78+
splashmark check
79+
* use splashmark env to generate an example .env file
80+
splashmark env > .env
8281
* to create a social image for Github
83-
splashmark -w 1280 -c 640 -z 100 -i "<user>/<repo>" -k "line 1\nline 2" -r EEEEEE -e median,dark,grain search search <repo>.jpg <keyword>
82+
splashmark -w 1280 -c 640 -z 100 -i "<user>/<repo>" -k "line 1\nline 2" -r EEEEEE -e median,dark,grain unsplash <keyword>
8483
* to create a social image for Instagram
85-
splashmark -w 1080 -c 1080 -z 150 -i "Carpe diem" -e dark search instagram.jpg clouds
84+
splashmark -w 1080 -c 1080 -z 150 -i "Carpe diem" -e dark pixabay clouds clouds.jpg
8685
* to create a social image for Facebook
87-
splashmark -w 1200 -c 630 -i "20 worldwide destinations\nwith the best beaches\nfor unforgettable holidays" -e dark search facebook.jpg copacabana
86+
splashmark -w 1200 -c 630 -i "20 worldwide destinations\nwith the best beaches\nfor unforgettable holidays" -e dark unsplash copacabana
8887
```
8988

9089
## installation

0 commit comments

Comments
 (0)