removed some spaces

[andy/dehydrated.git] / README.md

diff --git a/README.md b/README.md
index 63494ba6e720d4d6f4de8257272f4fddb7264365..6476bbfc84d9cb96c5df689ed106958f2b118f95 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,12 +1,14 @@
-# letsencrypt.sh [![Build Status](https://travis-ci.org/lukas2511/letsencrypt.sh.svg?branch=master)](https://travis-ci.org/lukas2511/letsencrypt.sh)
+# dehydrated [![Build Status](https://travis-ci.org/lukas2511/dehydrated.svg?branch=master)](https://travis-ci.org/lukas2511/dehydrated)

 
 

-[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=EL9BQ5FQGG73Y)
+![](docs/logo.jpg)

 
 

-This is a client for signing certificates with an ACME-server (currently only provided by letsencrypt) implemented as a relatively simple bash-script.
+*Note: This project was renamed from letsencrypt.sh because the original name was violating Let's Encrypts trademark policy. I know that this results in quite a lot of installations failing but I didn't have a choice... For now there is a wrapper script for compatibility with old config locations and symlinks, but it will be removed in a few weeks.*
+
+This is a client for signing certificates with an ACME-server (currently only provided by Let's Encrypt) implemented as a relatively simple bash-script.

 
 It uses the `openssl` utility for everything related to actually handling keys and certificates, so you need to have that installed.
 
 
 It uses the `openssl` utility for everything related to actually handling keys and certificates, so you need to have that installed.
 

-Other dependencies are: curl, sed, grep, mktemp (all found on almost any system, curl being the only exception)
+Other dependencies are: cURL, sed, grep, mktemp (all found on almost any system, cURL being the only exception)

 
 Current features:
 - Signing of a list of domains
 
 Current features:
 - Signing of a list of domains


@@ -14,8 +16,7 @@ Current features:
 - Renewal if a certificate is about to expire or SAN (subdomains) changed
 - Certificate revocation
 
 - Renewal if a certificate is about to expire or SAN (subdomains) changed
 - Certificate revocation
 

-Please keep in mind that this software and even the acme-protocol are relatively young and may still have some unresolved issues.
-Feel free to report any issues you find with this script or contribute by submitting a pullrequest.
+Please keep in mind that this software and even the acme-protocol are relatively young and may still have some unresolved issues. Feel free to report any issues you find with this script or contribute by submitting a pull request.

 
 ### Getting started
 
 
 ### Getting started
 


@@ -23,14 +24,14 @@ For getting started I recommend taking a look at [docs/domains_txt.md](docs/doma
 
 Generally you want to set up your WELLKNOWN path first, and then fill in domains.txt.
 
 
 Generally you want to set up your WELLKNOWN path first, and then fill in domains.txt.
 

-**Please note that you should use the staging URL when experimenting with this script to not hit letsencrypts rate limits.** See [docs/staging.md](docs/staging.md).
+**Please note that you should use the staging URL when experimenting with this script to not hit Let's Encrypt's rate limits.** See [docs/staging.md](docs/staging.md).

 
 If you have any problems take a look at our [Troubleshooting](docs/troubleshooting.md) guide.
 
 ## Usage:
 
 ```text
 
 If you have any problems take a look at our [Troubleshooting](docs/troubleshooting.md) guide.
 
 ## Usage:
 
 ```text

-Usage: ./letsencrypt.sh [-h] [command [argument]] [parameter [argument]] [parameter [argument]] ...
+Usage: ./dehydrated [-h] [command [argument]] [parameter [argument]] [parameter [argument]] ...

 
 Default command: help
 
 
 Default command: help
 


@@ -43,11 +44,18 @@ Commands:
  --env (-e)                       Output configuration variables for use in other scripts
 
 Parameters:
  --env (-e)                       Output configuration variables for use in other scripts
 
 Parameters:

+ --full-chain (-fc)               Print full chain when using --signcsr
+ --ipv4 (-4)                      Resolve names to IPv4 addresses only
+ --ipv6 (-6)                      Resolve names to IPv6 addresses only

  --domain (-d) domain.tld         Use specified domain name(s) instead of domains.txt entry (one certificate!)
  --domain (-d) domain.tld         Use specified domain name(s) instead of domains.txt entry (one certificate!)

+ --keep-going (-g)                Keep going after encountering an error while creating/renewing multiple certificates in cron mode

  --force (-x)                     Force renew of certificate even if it is longer valid than value in RENEW_DAYS
  --force (-x)                     Force renew of certificate even if it is longer valid than value in RENEW_DAYS

+ --no-lock (-n)                   Don't use lockfile (potentially dangerous!)
+ --ocsp                           Sets option in CSR indicating OCSP stapling to be mandatory

  --privkey (-p) path/to/key.pem   Use specified private key instead of account key (useful for revocation)
  --privkey (-p) path/to/key.pem   Use specified private key instead of account key (useful for revocation)

- --config (-f) path/to/config.sh  Use specified config file
+ --config (-f) path/to/config     Use specified config file

  --hook (-k) path/to/hook.sh      Use specified script for hooks
  --hook (-k) path/to/hook.sh      Use specified script for hooks

+ --out (-o) certs/directory       Output certificates into the specified directory

  --challenge (-t) http-01|dns-01  Which challenge should be used? Currently http-01 and dns-01 are supported
  --algo (-a) rsa|prime256v1|secp384r1 Which public key algorithm should be used? Supported: rsa, prime256v1 and secp384r1
 ```
  --challenge (-t) http-01|dns-01  Which challenge should be used? Currently http-01 and dns-01 are supported
  --algo (-a) rsa|prime256v1|secp384r1 Which public key algorithm should be used? Supported: rsa, prime256v1 and secp384r1
 ```