Skip to content

Commit

Permalink
docs: updates on workflows
Browse files Browse the repository at this point in the history
Added information on documentation
  • Loading branch information
ADMSK\AVROGAL1 committed Mar 13, 2021
1 parent 41c6df1 commit 36c7565
Show file tree
Hide file tree
Showing 4 changed files with 885 additions and 452 deletions.
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
* [<em>Table of contents</em>](#table-of-contents)
* [<em>Description</em>](#description)
* [<em>Inputs</em>](#inputs)
* [category](#category)
* [language](#language)
* [pattern](#pattern)
* [width](#width)
* [height](#height)
Expand All @@ -55,7 +55,7 @@
* [colorPattern](#colorpattern)
* [name](#name)
* [path](#path)
* [<em>Outputs</em>`](#outputs)
* [<em>Outputs</em>](#outputs)
* [image](#image)
* [<em>Examples</em>](#examples)
* [<em>Visitor stats</em>](#visitor-stats)
Expand Down Expand Up @@ -89,51 +89,51 @@ Creates _**Styled Proverbs**_ by language and input color parameters.

## _Inputs_

### `category`
### `language`

**Optional** Proverb's category (default **random**)
**Optional** Proverb's language (default **random**)

### `pattern`

**Optional** Quote's image background pattern (default **random**)
**Optional** Proverb's image background pattern (default **random**)

### `width`

**Optional** Quote's image width (default **100%**)
**Optional** Proverb's image width (default **100%**)

### `height`

**Optional** Quote's image height (default **100%**)
**Optional** Proverb's image height (default **100%**)

### `backgroundColor`

**Optional** Quote's image background color (default **%23FFFFFF**)
**Optional** Proverb's image background color (default **%23FFFFFF**)

### `fontColor`

**Optional** Quote's image font color (default **%230A83DC**)
**Optional** Proverb's image font color (default **%230A83DC**)

### `opacity`

**Optional** Quote's image background opacity (default **0.3**)
**Optional** Proverb's image background opacity (default **0.3**)

### `colorPattern`

**Optional** Quote's image text color (default **%23FFE0E9**)
**Optional** Proverb's image text color (default **%23FFE0E9**)

### `name`

**Optional** Quote's image name (default **quote**)
**Optional** Proverb's image name (default **proverb**)

### `path`

**Optional** Quote's image path (default **images**)
**Optional** Proverb's image path (default **images**)

## _Outputs_`
## _Outputs_

### `image`

Generated quote image (stored in the `path` directory)
Generated proverb image (stored in the `path` directory)

## _Examples_

Expand All @@ -149,7 +149,7 @@ Generated quote image (stored in the `path` directory)

Running locally:

- `npm run start:action --action github-action-proverbs --category 'programming' --pattern 'wiggle' --name quote --path images`
- `npm run start:action --action github-action-proverbs --language 'french' --pattern 'wiggle' --name proverb --path images`

## _Visitor stats_

Expand Down
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,5 +54,5 @@ runs:

# Ref: https://haya14busa.github.io/github-action-brandings/
branding:
icon: 'image'
icon: 'bookmark'
color: 'blue'
Loading

0 comments on commit 36c7565

Please sign in to comment.