coolaj86/pem.js
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

v1.0.1: update docs

Browse Source
This commit is contained in:
AJ ONeal 2019-10-12 19:31:19 -06:00
parent 72d95531d3
commit bafed25457
2 changed files with 45 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
README.md
View File

@ -2,6 +2,10 @@
Lightweight, Zero-Dependency PEM encoder and decoder. Lightweight, Zero-Dependency PEM encoder and decoder.
Built by [The Root Company](https://therootcompany.com)
for [Greenlock](https://greenlock.domains)
and [ACME.js](https://git.rootprojects.org/root/acme.js)
| ~300b gzipped | ~300b gzipped
| ~650b minified | ~650b minified
| ~1k full | ~1k full
@ -13,8 +17,6 @@ Lightweight, Zero-Dependency PEM encoder and decoder.
- [x] Node.js - [x] Node.js
- [x] Browsers - [x] Browsers
# Support
This library supports PEM, which is pretty boring on its own. This library supports PEM, which is pretty boring on its own.
Most likely you are also interested in some of the following: Most likely you are also interested in some of the following:
@ -25,6 +27,9 @@ Most likely you are also interested in some of the following:
- [x509.js](https://git.rootprojects.org/root/x509.js) - [x509.js](https://git.rootprojects.org/root/x509.js)
- [asn1.js](https://git.rootprojects.org/root/asn1.js) - [asn1.js](https://git.rootprojects.org/root/asn1.js)
Want to [contribute](#contributions)?
Need [commercial support](#commercial-support)?
# Usage # Usage
- PEM.parseBlock(str) - PEM.parseBlock(str)
@ -66,13 +71,16 @@ SGVsbG8sIOS4lueVjCE=
# Install # Install
## Node / Webpack This works equally well in Browsers and Node.js,
but has slightly different code.
## Node (and Webpack)
```js ```js
npm install -g @root/pem npm install -g @root/pem
``` ```
## Browsers ## Browsers (Vanilla JS)
```html ```html
<script src="https://unpkg.com/@root/pem/dist/pem.all.js"></script> <script src="https://unpkg.com/@root/pem/dist/pem.all.js"></script>
@ -115,8 +123,40 @@ keys and certificates such as:
- [x] PKCS#8 (RSA and ECDSA Keypairs) - [x] PKCS#8 (RSA and ECDSA Keypairs)
- [x] SEC#1 (ECDSARSA Public and Private Keys) - [x] SEC#1 (ECDSARSA Public and Private Keys)
# Contributions
[Root](https://therootcompany.com) is a collection of experts
who trust each other, enjoy working together, and communally share work.
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**.
We welcome your support and participation in our community:
- Paypal: [\$5](https://paypal.me/rootprojects/5) [\$10](https://paypal.me/rootprojects/10) Any amount: <paypal@therootcompany.com>
- Patreon: <https://patreon.com/rootprojects>
We chat on [Keybase#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 # Legal
Copyright [AJ ONeal](https://coolaj86.com),
[Root](https://therootcompany.com) 2018-2019
MPL-2.0 | MPL-2.0 |
[Terms of Use](https://therootcompany.com/legal/#terms) | [Terms of Use](https://therootcompany.com/legal/#terms) |
[Privacy Policy](https://therootcompany.com/legal/#privacy) [Privacy Policy](https://therootcompany.com/legal/#privacy)

2
package.json
View File

@ -1,6 +1,6 @@
{ {
"name": "@root/pem", "name": "@root/pem",
"version": "1.0.0", "version": "1.0.1",
"description": "VanillaJS, Lightweight, Zero-Dependency, PEM encoder and decoder.", "description": "VanillaJS, Lightweight, Zero-Dependency, PEM encoder and decoder.",
"main": "index.js", "main": "index.js",
"browser": { "browser": {