Skip to content

Commit 36c7565

Browse files
author
ADMSK\AVROGAL1
committed
docs: updates on workflows
Added information on documentation
1 parent 41c6df1 commit 36c7565

4 files changed

Lines changed: 885 additions & 452 deletions

File tree

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
* [<em>Table of contents</em>](#table-of-contents)
4646
* [<em>Description</em>](#description)
4747
* [<em>Inputs</em>](#inputs)
48-
* [category](#category)
48+
* [language](#language)
4949
* [pattern](#pattern)
5050
* [width](#width)
5151
* [height](#height)
@@ -55,7 +55,7 @@
5555
* [colorPattern](#colorpattern)
5656
* [name](#name)
5757
* [path](#path)
58-
* [<em>Outputs</em>`](#outputs)
58+
* [<em>Outputs</em>](#outputs)
5959
* [image](#image)
6060
* [<em>Examples</em>](#examples)
6161
* [<em>Visitor stats</em>](#visitor-stats)
@@ -89,51 +89,51 @@ Creates _**Styled Proverbs**_ by language and input color parameters.
8989

9090
## _Inputs_
9191

92-
### `category`
92+
### `language`
9393

94-
**Optional** Proverb's category (default **random**)
94+
**Optional** Proverb's language (default **random**)
9595

9696
### `pattern`
9797

98-
**Optional** Quote's image background pattern (default **random**)
98+
**Optional** Proverb's image background pattern (default **random**)
9999

100100
### `width`
101101

102-
**Optional** Quote's image width (default **100%**)
102+
**Optional** Proverb's image width (default **100%**)
103103

104104
### `height`
105105

106-
**Optional** Quote's image height (default **100%**)
106+
**Optional** Proverb's image height (default **100%**)
107107

108108
### `backgroundColor`
109109

110-
**Optional** Quote's image background color (default **%23FFFFFF**)
110+
**Optional** Proverb's image background color (default **%23FFFFFF**)
111111

112112
### `fontColor`
113113

114-
**Optional** Quote's image font color (default **%230A83DC**)
114+
**Optional** Proverb's image font color (default **%230A83DC**)
115115

116116
### `opacity`
117117

118-
**Optional** Quote's image background opacity (default **0.3**)
118+
**Optional** Proverb's image background opacity (default **0.3**)
119119

120120
### `colorPattern`
121121

122-
**Optional** Quote's image text color (default **%23FFE0E9**)
122+
**Optional** Proverb's image text color (default **%23FFE0E9**)
123123

124124
### `name`
125125

126-
**Optional** Quote's image name (default **quote**)
126+
**Optional** Proverb's image name (default **proverb**)
127127

128128
### `path`
129129

130-
**Optional** Quote's image path (default **images**)
130+
**Optional** Proverb's image path (default **images**)
131131

132-
## _Outputs_`
132+
## _Outputs_
133133

134134
### `image`
135135

136-
Generated quote image (stored in the `path` directory)
136+
Generated proverb image (stored in the `path` directory)
137137

138138
## _Examples_
139139

@@ -149,7 +149,7 @@ Generated quote image (stored in the `path` directory)
149149
150150
Running locally:
151151
152-
- `npm run start:action --action github-action-proverbs --category 'programming' --pattern 'wiggle' --name quote --path images`
152+
- `npm run start:action --action github-action-proverbs --language 'french' --pattern 'wiggle' --name proverb --path images`
153153

154154
## _Visitor stats_
155155

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,5 +54,5 @@ runs:
5454

5555
# Ref: https://haya14busa.github.io/github-action-brandings/
5656
branding:
57-
icon: 'image'
57+
icon: 'bookmark'
5858
color: 'blue'

0 commit comments

Comments
 (0)