forked from root/acme.js
		
	v3.0.4: update docs
This commit is contained in:
		
							parent
							
								
									0107bc1d1f
								
							
						
					
					
						commit
						754c623cd1
					
				
							
								
								
									
										18
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										18
									
								
								README.md
									
									
									
									
									
								
							@ -6,6 +6,23 @@ ACME.js is a _low-level_ client for Let's Encrypt.
 | 
			
		||||
 | 
			
		||||
Looking for an **easy**, _high-level_ client? Check out [Greenlock.js](https://git.rootprojects.org/root/greenlock.js).
 | 
			
		||||
 | 
			
		||||
```js
 | 
			
		||||
var acme = ACME.create({ maintainerEmail, packageAgent, notify });
 | 
			
		||||
await acme.init(directoryUrl);
 | 
			
		||||
 | 
			
		||||
// Create Let's Encrypt Account
 | 
			
		||||
var accountOptions = { subscriberEmail, agreeToTerms, accountKey };
 | 
			
		||||
var account = await acme.accounts.create(accountOptions);
 | 
			
		||||
 | 
			
		||||
// Validate Domains
 | 
			
		||||
var certificateOptions = { account, accountKey, csr, domains, challenges };
 | 
			
		||||
var pems = await acme.certificates.create(certificateOptions);
 | 
			
		||||
 | 
			
		||||
// Get SSL Certificate
 | 
			
		||||
var fullchain = pems.cert + '\n' + pems.chain + '\n';
 | 
			
		||||
await fs.promises.writeFile('fullchain.pem', fullchain, 'ascii');
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
# Online Demo
 | 
			
		||||
 | 
			
		||||
See https://greenlock.domains
 | 
			
		||||
@ -186,7 +203,6 @@ A basic example includes the following:
 | 
			
		||||
[examples/README.md](https://git.rootprojects.org/root/acme.js/src/branch/master/examples/README.md)
 | 
			
		||||
covers all of these steps, with comments.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
# Install
 | 
			
		||||
 | 
			
		||||
To make it easy to generate, encode, and decode keys and certificates,
 | 
			
		||||
 | 
			
		||||
@ -1,6 +1,6 @@
 | 
			
		||||
{
 | 
			
		||||
	"name": "@root/acme",
 | 
			
		||||
	"version": "3.0.2",
 | 
			
		||||
	"version": "3.0.4",
 | 
			
		||||
	"description": "Free SSL certificates for Node.js and Browsers. Issued via Let's Encrypt",
 | 
			
		||||
	"homepage": "https://rootprojects.org/acme/",
 | 
			
		||||
	"main": "acme.js",
 | 
			
		||||
 | 
			
		||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user