Skip to content

Commit 7bd85a6

Browse files
committed
updating README
1 parent 6e80491 commit 7bd85a6

1 file changed

Lines changed: 20 additions & 10 deletions

File tree

README.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# gradle-json-resume
22

3-
[![](https://jitpack.io/v/warlordofmars/gradle-json-resume.svg)](https://jitpack.io/#warlordofmars/gradle-json-resume)
3+
[![jitpack build](https://jitpack.io/v/warlordofmars/gradle-json-resume.svg)](https://jitpack.io/#warlordofmars/gradle-json-resume)
44

55
## Overview
66

@@ -14,14 +14,13 @@ Gradle Plugin to provide a full CI/CD workflow for a [JSON Resume](https://jsonr
1414
* **Multi-Forrmat Build** - Resumé source can be compiled into a number of different output formats: HTML, PDF, Markdown, YAML
1515
* **Custom Resumé Themes** - Each configured output format can be configured to use a custom [JSON Resume Theme](https://jsonresume.org/themes/)
1616
* **Resumé Deployment** - Resumé will be deployed to several locations for ultimate consumpton:
17-
* **Web** - Resumé is published to a static website hosted in AWS S3
18-
* **Google Drive** - Resumé is published to a Google Drive document
19-
* **iCloud** - Resumé is published to a iCloud Drive document
20-
* **Print** - Resumé is printed using a local printer
17+
* **Web** - Resumé is published to a static website hosted in AWS S3
18+
* **Google Drive** - Resumé is published to a Google Drive document
19+
* **iCloud** - Resumé is published to a iCloud Drive document
20+
* **Print** - Resumé is printed using a local printer
2121

2222
* **Test Results** - All tests that are performed throughout the `build` and `deploy` process are captured and recorded in a JUnit-style XML report.
2323

24-
2524
## Prerequisites
2625

2726
There are two prerequisites required to exist prior to using this plugin:
@@ -101,9 +100,20 @@ To configure:
101100

102101
```gradle
103102
resume {
104-
resumeFormats = rootProject.resumeFormats
105-
resumeSource = rootProject.resumeSource
106-
themes = rootProject.themes
103+
104+
// list of resume formats to be generated (must contain 'html' and 'pdf')
105+
resumeFormats = ['html', 'pdf', 'yaml', 'md']
106+
107+
// the JSON Resume source file
108+
resumeSource = 'resume.json'
109+
110+
// mapping of themes to be used with each resumeFormat configured
111+
themes = [
112+
html: '',
113+
pdf: ''
114+
]
115+
116+
107117
websiteUrl = rootProject.websiteUrl
108118
websitePrefix = rootProject.websitePrefix
109119
numberOfCopies = rootProject.numberOfCopies
@@ -127,4 +137,4 @@ This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md
127137

128138
## Acknowledgments
129139

130-
*
140+
* Using [gdrive](https://github.com/prasmussen/gdrive) (Google Drive CLI) to publish resumé file to Google Drive.

0 commit comments

Comments
 (0)