Commit 21c2d3ab authored by Aral Balkan's avatar Aral Balkan
Browse files

Update readme

parent 85351a14
......@@ -8,6 +8,26 @@ In developing Henry, I will be taking as modular an approach as possible so that
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.
## Run
You can run the client separately from Place during development:
```shell
npm run dev
```
## Build
To create the distribution build Single Page Application ready to be loaded by Place:
```shell
npm run build
```
This will create your build into the `../henry-dist` directory.
(The official distribution build is hosted in the [henry-dist](https://source.small-tech.org/small-web/henry-dist) repository.)
## Current status
- (Re)generates a person’s key materials from their passphrase.
......@@ -25,3 +45,17 @@ The reference implementation uses [Vite](https://vitejs.dev) and [Svelte](https:
Authentication is done using an asymmetrically-encrypted access token we call a Bernstein Token.
For more information, please see [Place](https://github.com/small-tech/place), the very early-stage reference implementation Small Web Protocol Server.
## Like this? Fund us!
[Small Technology Foundation](https://small-tech.org) is a tiny, independent not-for-profit.
We exist in part thanks to patronage by people like you. If you share [our vision](https://small-tech.org/about/#small-technology) and want to support our work, please [become a patron or donate to us](https://small-tech.org/fund-us) today and help us continue to exist.
## Copyright
Copyright © 2021-present [Aral Balkan](https://ar.al), [Small Technology Foundation](https://small-tech.org).
## License
[AGPL 3.0](./LICENSE).
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