Commit 4d9e7f8c authored by Aral Balkan's avatar Aral Balkan
Browse files

The spike is now the basis of the reference implementation

(Which I’ve lovingly named “Henry.” Because, why not?)
parent 766c8a45
{
"name": "sign-in",
"name": "@small-web/henry",
"version": "1.0.0",
"description": "",
"description": "Small Web Protocol Client Reference Implementation (Henry).",
"main": "index.js",
"type": "module",
"scripts": {
......
# Small Web Protocol sign-in spike
# Small Web Reference Client (Henry)
## The example demonstrates
Henry is the Small Web Reference Client that’s installed if you do not specify a different one. It implements the essential Small Web client protocols and conventions.
In developing Henry, I will be taking as modular an approach as possible so that other clients can easily plug-and-play core functionality (or fork Henry and build their clients on top of it while remaining able to update core small web functionality in their clients just by keeping their dependencies up to date without having to follow updates to Henry itself and cherry picking updates from it.)
## Usage
Henry is not meant to be used directly. It is automatically cloned and used by [Place](https://github.com/small-tech/place) – the Small Web Protocol Server.
## Current status
As of Fri, Feb 19, 2021, implements:
- (Re)generating a person’s key materials from their passphrase.
- Retrieving a Bernstein token from a small web protocol server (e.g., from the current in-development reference implementation, called Place).
- Decrypting a Bernstein token using the person’s private key.
- Making a private web socket connection to the small web protocol server using the decrypted Bernstein token.
This example uses Snowpack and Svelte but Small Web clients can be written using any combination of tools as long as they output a static single-page app that conforms to the small web protocols.
## Note on technology choices
The reference implementation uses Snowpack and Svelte but Small Web clients can be written using any combination of tools as long as they output a static single-page app that conforms to the small web protocols.
## Authentication
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment