Run prettier on docs

This commit is contained in:
Yarmo Mackenbach 2020-11-08 02:05:34 +01:00
parent 52227e5cee
commit 1a2c6b7b84
7 changed files with 63 additions and 39 deletions

View file

@ -1,20 +1,24 @@
- Getting started - Getting started
- [Installation](installation.md) - [Installation](installation.md)
- [Quick start (Node.js)](quickstart-nodejs.md) - [Quick start (Node.js)](quickstart-nodejs.md)
- [Quick start (browser)](quickstart-browser.md) - [Quick start (browser)](quickstart-browser.md)
- [Terminology](terminology.md) - [Terminology](terminology.md)
- Reference - Reference
- [API](api.md) - [API](api.md)
- [Service provider data object](serviceproviderdataobject.md) - [Service provider data object](serviceproviderdataobject.md)
- Concepts - Concepts
- [DOIP](doip.md) - [DOIP](doip.md)
- [Proofs](proofs.md) - [Proofs](proofs.md)
- [Claims](claims.md) - [Claims](claims.md)
- [Service providers](serviceproviders.md) - [Service providers](serviceproviders.md)
- Service providers - Service providers
- [dev.to](serviceproviders/devto.md) - [dev.to](serviceproviders/devto.md)
- [discourse](serviceproviders/discourse.md) - [discourse](serviceproviders/discourse.md)
- [dns](serviceproviders/dns.md) - [dns](serviceproviders/dns.md)

View file

@ -2,14 +2,14 @@
## verify ## verify
*(async)* doip.verify(uri, [fingerprint], [opts]) _(async)_ doip.verify(uri, [fingerprint], [opts])
Verifies the identity behind the provided **uri** using the **fingerprint**. Verifies the identity behind the provided **uri** using the **fingerprint**.
**Parameters** **Parameters**
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
|-------------|--------|-----------|----------------------------------| | ----------- | ------ | --------- | -------------------------------- |
| uri | string | true | the URI to an identity to verify | | uri | string | true | the URI to an identity to verify |
| fingerprint | string | false | the fingerprint of the claim | | fingerprint | string | false | the fingerprint of the claim |
| opts | object | false | options (see below) | | opts | object | false | options (see below) |
@ -17,7 +17,7 @@ Verifies the identity behind the provided **uri** using the **fingerprint**.
**Options** **Options**
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
|-------------------|---------|----------------------|---------------------------------------------------------------------| | ----------------- | ------- | -------------------- | ------------------------------------------------------------------- |
| returnMatchesOnly | boolean | false | only return matching service providers, do not attempt verification | | returnMatchesOnly | boolean | false | only return matching service providers, do not attempt verification |
| proxyPolicy | string | 'adaptive' | when to use a proxy ['adaptive', 'always', 'never'] | | proxyPolicy | string | 'adaptive' | when to use a proxy ['adaptive', 'always', 'never'] |
| doipProxyHostname | string | 'proxy.keyoxide.org' | the hostname of the proxy server | | doipProxyHostname | string | 'proxy.keyoxide.org' | the hostname of the proxy server |

View file

@ -5,6 +5,7 @@
[2020-11-06](https://codeberg.org/keyoxide/doipjs/releases/tag/0.4.2) [2020-11-06](https://codeberg.org/keyoxide/doipjs/releases/tag/0.4.2)
### Changed ### Changed
- URLs in package.json - URLs in package.json
## 0.4.1 ## 0.4.1
@ -12,6 +13,7 @@
[2020-11-06](https://codeberg.org/keyoxide/doipjs/releases/tag/0.4.1) [2020-11-06](https://codeberg.org/keyoxide/doipjs/releases/tag/0.4.1)
### Changed ### Changed
- Update README - Update README
- Add image to coverpage - Add image to coverpage
@ -20,17 +22,21 @@
[2020-11-06](https://codeberg.org/keyoxide/doipjs/releases/tag/0.4.0) [2020-11-06](https://codeberg.org/keyoxide/doipjs/releases/tag/0.4.0)
### Added ### Added
- Custom request handler for DNS service provider - Custom request handler for DNS service provider
- Docs - Docs
### Changed ### Changed
- Service provider data structure - Service provider data structure
- More consistent handling of options - More consistent handling of options
### Removed ### Removed
- dotenv dependency - dotenv dependency
### Fixed ### Fixed
- Crash for unexpected JSON data structure - Crash for unexpected JSON data structure
- Body in http requests - Body in http requests
@ -39,14 +45,17 @@
[2020-11-04](https://codeberg.org/keyoxide/doipjs/releases/tag/0.3.0) [2020-11-04](https://codeberg.org/keyoxide/doipjs/releases/tag/0.3.0)
### Added ### Added
- Liberapay service provider - Liberapay service provider
- Proxy request handler - Proxy request handler
### Changed ### Changed
- Improve handling of arrays in JSON - Improve handling of arrays in JSON
- Customizable proxy hostname - Customizable proxy hostname
### Fixed ### Fixed
- Dots in URL regex - Dots in URL regex
## 0.2.0 ## 0.2.0

View file

@ -73,12 +73,12 @@ verification of DOIPs. Please refer to the [list of supported service providers]
The endgame of using DOIP is to add at least two profile. Proving that you own The endgame of using DOIP is to add at least two profile. Proving that you own
a single profile—in a way—doesn't prove anything. The issue is that a single profile—in a way—doesn't prove anything. The issue is that
we cannot prove that **you**, the physical being **you**, holds that key. DOIP we cannot prove that **you**, the physical being **you**, holds that key. DOIP
can only verify that "*whoever holds that key also holds that profile*". can only verify that "_whoever holds that key also holds that profile_".
By adding at least two profiles, you can create meaningful links between those By adding at least two profiles, you can create meaningful links between those
profiles. If someone knows **you**, the physical being **you**, is **Alice** on profiles. If someone knows **you**, the physical being **you**, is **Alice** on
website A, they will also now know that you are **Alice123** on website B, website A, they will also now know that you are **Alice123** on website B,
simply because "*whoever holds that key also holds both of those profiles*". simply because "_whoever holds that key also holds both of those profiles_".
## Why the snail logo? ## Why the snail logo?

View file

@ -1,12 +1,21 @@
<!DOCTYPE html> <!DOCTYPE html>
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="UTF-8"> <meta charset="UTF-8" />
<title>doip.js</title> <title>doip.js</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" /> <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<meta name="description" content="doip.js documentation, Node.js library for Decentralized OpenPGP Identity Proofs"> <meta
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0"> name="description"
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css"> content="doip.js documentation, Node.js library for Decentralized OpenPGP Identity Proofs"
/>
<meta
name="viewport"
content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0"
/>
<link
rel="stylesheet"
href="//cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css"
/>
</head> </head>
<body> <body>
<div id="app"></div> <div id="app"></div>

View file

@ -40,6 +40,7 @@ Mandatory: true
``` ```
Currently, only two types of service providers are supported: Currently, only two types of service providers are supported:
- `web`: traditional website platforms - `web`: traditional website platforms
- `communication`: platforms for interpersonal communication - `communication`: platforms for interpersonal communication
@ -124,6 +125,7 @@ Mandatory: true
``` ```
The format in which the claim's fingerprint is expected to be found in the proof. There are three supported claim formats: The format in which the claim's fingerprint is expected to be found in the proof. There are three supported claim formats:
- `uri`: the claim is formulated as `openpgp4fpr:FINGERPRINT` - `uri`: the claim is formulated as `openpgp4fpr:FINGERPRINT`
- `message`: the claim is formulated as `[Verifying my OpenPGP key: openpgp4fpr:FINGERPRINT]` - `message`: the claim is formulated as `[Verifying my OpenPGP key: openpgp4fpr:FINGERPRINT]`
- `fingerprint`: the claim is formulated as `FINGERPRINT` - `fingerprint`: the claim is formulated as `FINGERPRINT`
@ -151,6 +153,7 @@ Mandatory: true
``` ```
How the claim relates to the proof. There are three supported claim relations: How the claim relates to the proof. There are three supported claim relations:
- `contains`: the proof is a long text containing the claim - `contains`: the proof is a long text containing the claim
- `equals`: the proof is equal to the claim - `equals`: the proof is equal to the claim
- `oneOf`: the proof is an array of string, one of which is the claim - `oneOf`: the proof is an array of string, one of which is the claim

View file

@ -12,11 +12,10 @@ For more detailed information, please refer to [Claims](claims.md).
## Cryptographic key ## Cryptographic key
According to [Wikipedia](<https://en.wikipedia.org/wiki/Key_(cryptography)>):
According to [Wikipedia](https://en.wikipedia.org/wiki/Key_(cryptography)):
> [...] a piece of information (a parameter) that determines the functional > [...] a piece of information (a parameter) that determines the functional
output of a cryptographic algorithm. > output of a cryptographic algorithm.
Cryptographic keys can be used to encrypt/decrypt data and verify digital Cryptographic keys can be used to encrypt/decrypt data and verify digital
signatures. signatures.