diff --git a/README.md b/README.md index b581256..d4be8d2 100644 --- a/README.md +++ b/README.md @@ -16,9 +16,10 @@ docker run -v $(pwd):/usr/workspace/downloads \ viniciusgava/portaldorh-holerite-download:latest ``` The above command will save pdf in ``$(pwd)``, it means the directory where you run it. -File name is the search date, ``YYYY-MM.pdf``. -**eg:** +File name is the search year + search month, ``YYYY-MM.pdf``. + +**example:** ``2018-03.pdf`` @@ -26,28 +27,36 @@ File name is the search date, ``YYYY-MM.pdf``. #### RH_SEARCH_YEAR Search Year + **Required:** Yes #### RH_SEARCH_MONTH Search Month + **Required:** Yes ### RH_USERNAME Your username to login + **Required:** Yes ### RH_PASSWORD Your password to login + **Required:** Yes #### RH_URL Portal do RH URL + **Required:** No + **Default:** https://www.portaldorh.com.br/portal_rckt/Auto_Principal.aspx ### DOWNLOAD_PATH Where files will be saved. + **Required:** No + **Default:** /usr/workspace/downloads ### Mail Gun feature - ENV variables @@ -55,40 +64,54 @@ All Required fields bellow are required **only** if ``MAIL_GUN_ENABLE`` env sett #### MAIL_GUN_ENABLE Integrate with mail gun? true or false + **Required:** No + **Default:** false #### MAIL_GUN_KEY Mail Gun API Key + **Required:** Yes #### MAIL_GUN_DOMAIN Mail Gun Domain + **Required:** Yes #### MAIL_GUN_FROM Mail origin + **Required:** Yes + **Example:**: Name #### MAIL_GUN_TO Mail destination + **Required:** Yes + **Example:**: Name #### MAIL_GUN_SUBJECT Mail subject + **Required:** Yes + **Placeholder Available:** Yes #### MAIL_GUN_TEXT Mail content as text + **Required:** Yes if ``MAIL_GUN_HTML`` is not setted + **Placeholder Available:** Yes #### MAIL_GUN_HTML Mail content as text + **Required:** Yes if ``MAIL_GUN_TEXT`` is not setted + **Placeholder Available:** Yes ### Push Bullet feature - ENV variables @@ -96,25 +119,33 @@ All Required fields bellow are required **only** if ``PUSH_BULLET_ENABLE`` env s #### PUSH_BULLET_ENABLE Integrate with push bullet? true or false + **Required:** No + **Default:** false #### PUSH_BULLET_TOKEN Push Bullet API Token + **Required:** Yes #### PUSH_BULLET_TITLE Notification Title + **Required:** Yes + **Placeholder Available:** Yes #### PUSH_BULLET_BODY Notification Body + **Required:** Yes + **Placeholder Available:** Yes ## Usage - Local Makefile and instruction bellow expected you uses python3. + It also expected you already have a chrome webdrive installed. 1. Clone repository @@ -124,6 +155,7 @@ It also expected you already have a chrome webdrive installed. ## Integrations Placeholder Some integration fields accept placeholder, that means you can use internal fields used on integration on your texts. + Fields that accept placeholders are marked on **Env Variables** of each integration. ### Placeholder syntax @@ -179,6 +211,7 @@ Example: 0 8 7 * * sh ~/automate/holerite/run.sh >> ~/automate/holerite/holerite.log ```` The example bellow runs 8am of day 7 of every month. + You can generate a different crontab config on [https://crontab-generator.org](https://crontab-generator.org) ## Links