Compare commits
	
		
			4 Commits
		
	
	
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| a1a0f29c9b | |||
| 87698d902d | |||
| 31a3058f35 | |||
| bafed25457 | 
							
								
								
									
										76
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										76
									
								
								README.md
									
									
									
									
									
								
							@ -1,5 +1,9 @@
 | 
			
		||||
# @root/pem
 | 
			
		||||
 | 
			
		||||
Built by [The Root Company](https://therootcompany.com)
 | 
			
		||||
for [Greenlock](https://greenlock.domains)
 | 
			
		||||
and [ACME.js](https://git.rootprojects.org/root/acme.js)
 | 
			
		||||
 | 
			
		||||
Lightweight, Zero-Dependency PEM encoder and decoder.
 | 
			
		||||
 | 
			
		||||
| ~300b gzipped
 | 
			
		||||
@ -7,13 +11,11 @@ Lightweight, Zero-Dependency PEM encoder and decoder.
 | 
			
		||||
| ~1k full
 | 
			
		||||
|
 | 
			
		||||
 | 
			
		||||
-   [x] VanillaJS
 | 
			
		||||
-   [x] Zero-Dependency
 | 
			
		||||
-   [x] Zero Dependencies
 | 
			
		||||
-   [x] Universal Support
 | 
			
		||||
    -   [x] Node.js
 | 
			
		||||
    -   [x] Browsers
 | 
			
		||||
 | 
			
		||||
# Support
 | 
			
		||||
-   [x] VanillaJS
 | 
			
		||||
 | 
			
		||||
This library supports PEM, which is pretty boring on its own.
 | 
			
		||||
 | 
			
		||||
@ -25,6 +27,9 @@ Most likely you are also interested in some of the following:
 | 
			
		||||
-   [x509.js](https://git.rootprojects.org/root/x509.js)
 | 
			
		||||
-   [asn1.js](https://git.rootprojects.org/root/asn1.js)
 | 
			
		||||
 | 
			
		||||
Want to [contribute](#contributions)?
 | 
			
		||||
Need [commercial support](#commercial-support)?
 | 
			
		||||
 | 
			
		||||
# Usage
 | 
			
		||||
 | 
			
		||||
-   PEM.parseBlock(str)
 | 
			
		||||
@ -66,13 +71,30 @@ SGVsbG8sIOS4lueVjCE=
 | 
			
		||||
 | 
			
		||||
# Install
 | 
			
		||||
 | 
			
		||||
## Node / Webpack
 | 
			
		||||
This works equally well in Browsers and Node.js,
 | 
			
		||||
but has slightly different code.
 | 
			
		||||
 | 
			
		||||
```js
 | 
			
		||||
npm install -g @root/pem
 | 
			
		||||
## Node (and Webpack)
 | 
			
		||||
 | 
			
		||||
```bash
 | 
			
		||||
npm install --save @root/pem
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
## Browsers
 | 
			
		||||
```js
 | 
			
		||||
var PEM = require('@root/pem');
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
```js
 | 
			
		||||
// just the packer
 | 
			
		||||
var PEM = require('@root/pem/packer');
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
```js
 | 
			
		||||
// just the parser
 | 
			
		||||
var PEM = require('@root/pem/parser');
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
## Browsers (Vanilla JS)
 | 
			
		||||
 | 
			
		||||
```html
 | 
			
		||||
<script src="https://unpkg.com/@root/pem/dist/pem.all.js"></script>
 | 
			
		||||
@ -115,8 +137,46 @@ keys and certificates such as:
 | 
			
		||||
    -   [x] PKCS#8 (RSA and ECDSA Keypairs)
 | 
			
		||||
-   [x] SEC#1 (ECDSARSA Public and Private Keys)
 | 
			
		||||
 | 
			
		||||
# Contributions
 | 
			
		||||
 | 
			
		||||
Did this project save you some time? Maybe make your day? Even save the day?
 | 
			
		||||
 | 
			
		||||
Please say "thanks" via Paypal or Patreon:
 | 
			
		||||
 | 
			
		||||
-   Paypal: [\$5](https://paypal.me/rootprojects/5) | [\$10](https://paypal.me/rootprojects/10) | Any amount: <paypal@therootcompany.com>
 | 
			
		||||
-   Patreon: <https://patreon.com/rootprojects>
 | 
			
		||||
 | 
			
		||||
Where does your contribution go?
 | 
			
		||||
 | 
			
		||||
[Root](https://therootcompany.com) is a collection of experts
 | 
			
		||||
who trust each other and enjoy working together on deep-tech,
 | 
			
		||||
Indie Web projects.
 | 
			
		||||
 | 
			
		||||
Our goal is to operate as a sustainable community.
 | 
			
		||||
 | 
			
		||||
Your contributions - both in code and _especially_ monetarily -
 | 
			
		||||
help to not just this project, but also our broader work
 | 
			
		||||
of [projects](https://rootprojects.org) that fuel the **Indie Web**.
 | 
			
		||||
 | 
			
		||||
Also, we chat on [Keybase](https://keybase.io)
 | 
			
		||||
in [#rootprojects](https://keybase.io/team/rootprojects)
 | 
			
		||||
 | 
			
		||||
# Commercial Support
 | 
			
		||||
 | 
			
		||||
Do you need...
 | 
			
		||||
 | 
			
		||||
-   more features?
 | 
			
		||||
-   bugfixes, on _your_ timeline?
 | 
			
		||||
-   custom code, built by experts?
 | 
			
		||||
-   commercial support and licensing?
 | 
			
		||||
 | 
			
		||||
Contact <aj@therootcompany.com> for support options.
 | 
			
		||||
 | 
			
		||||
# Legal
 | 
			
		||||
 | 
			
		||||
Copyright [AJ ONeal](https://coolaj86.com),
 | 
			
		||||
[Root](https://therootcompany.com) 2018-2019
 | 
			
		||||
 | 
			
		||||
MPL-2.0 |
 | 
			
		||||
[Terms of Use](https://therootcompany.com/legal/#terms) |
 | 
			
		||||
[Privacy Policy](https://therootcompany.com/legal/#privacy)
 | 
			
		||||
 | 
			
		||||
@ -1,11 +1,17 @@
 | 
			
		||||
{
 | 
			
		||||
	"name": "@root/pem",
 | 
			
		||||
	"version": "1.0.0",
 | 
			
		||||
	"version": "1.0.4",
 | 
			
		||||
	"description": "VanillaJS, Lightweight, Zero-Dependency, PEM encoder and decoder.",
 | 
			
		||||
	"main": "index.js",
 | 
			
		||||
	"browser": {
 | 
			
		||||
		"./node/native.js": "./browser/native.js"
 | 
			
		||||
	},
 | 
			
		||||
	"files": [
 | 
			
		||||
		"*.js",
 | 
			
		||||
		"node",
 | 
			
		||||
		"browser",
 | 
			
		||||
		"dist"
 | 
			
		||||
	],
 | 
			
		||||
	"scripts": {
 | 
			
		||||
		"test": "node tests"
 | 
			
		||||
	},
 | 
			
		||||
 | 
			
		||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user