Skip to content

Commit

Permalink
docs fixes
Browse files Browse the repository at this point in the history
  * Some text has been improved
  * Typo fixes
  • Loading branch information
rzippert committed Sep 4, 2021
1 parent a2d4b50 commit 9f2142c
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ letsrenew is a python script that is able to retrieve a certificate from a host,

## requirements

Probably ''python3-openssl'' should be installed on your system. The provided binary has everything bundled.
To use the build script you need ''pyinstaller'' and ''fpm''.
Probably `python3-openssl` should be installed on your system. The provided binary has everything bundled.
To use the build script you need `pyinstaller` and `fpm`.

## instructions

The provided ''build.sh'' script should give you both a binary version as well as a debian package inside a ''dist'' directory.
The provided `build.sh` script should give you both a binary version as well as a debian package inside a `dist` directory.

## usage
```
Expand All @@ -21,11 +21,11 @@ positional arguments:
hostname Hostname that will be requested from the webserver.
optional arguments:
-h, --help show this help message and exit
-h, --help show this help message and exit.
-a ADDRESS, --address ADDRESS
Alternate address to connect (don't resolve the hostname).
Alternate address to connect (to circumvent proxies, balancers, etc...).
-p PORT, --port PORT Alternate port to connect to.
-j, --json Output in JSON fromat.
-j, --json Output in JSON format.
-l ALERT, --alert ALERT
Output only on alerts. Specify it as the validity threshold in days. 0 for
Always output (default).
Expand Down Expand Up @@ -65,4 +65,4 @@ This program is free software: you can redistribute it and/or modify it under th

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
4 changes: 2 additions & 2 deletions letsrenew.py
Original file line number Diff line number Diff line change
Expand Up @@ -100,11 +100,11 @@ def parse_arguments():
parser.add_argument("hostname",
action="store", help="Hostname that will be requested from the webserver.")
parser.add_argument("-a", "--address",
action="store", required=False, help="Alternate address to connect (don't resolve the hostname).")
action="store", required=False, help="Alternate address to connect (to circumvent proxies, balancers, etc...).")
parser.add_argument("-p", "--port", default=443, type=int,
action="store", required=False, help="Alternate port to connect to.")
parser.add_argument("-j", "--json", default=False,
action="store_true", required=False, help="Output in JSON fromat.")
action="store_true", required=False, help="Output in JSON format.")
parser.add_argument("-l", "--alert", default=0, type=int,
action="store", required=False, help="Output only on alerts. Specify it as the validity threshold in days. 0 for Always output (default).")

Expand Down

0 comments on commit 9f2142c

Please sign in to comment.