From 918cea1200efb36f2e74eed3ebcd32294286f979 Mon Sep 17 00:00:00 2001 From: nazeh Date: Fri, 25 Oct 2024 08:54:44 +0300 Subject: [PATCH 1/5] docs: add pubky icon to the readme --- .img/pubky-logo.svg | 4 ++++ README.md | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) create mode 100644 .img/pubky-logo.svg diff --git a/.img/pubky-logo.svg b/.img/pubky-logo.svg new file mode 100644 index 0000000..15e92ea --- /dev/null +++ b/.img/pubky-logo.svg @@ -0,0 +1,4 @@ + + + + diff --git a/README.md b/README.md index 23197ae..9d7637d 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Pubky +

pubky

> The Web, long centralized, must decentralize; Long decentralized, must centralize. From 0b6c0b88e8b15659a9b0afa556258c66dc5dc18a Mon Sep 17 00:00:00 2001 From: nazeh Date: Fri, 25 Oct 2024 09:03:37 +0300 Subject: [PATCH 2/5] docs: update pubky logo --- .img/pubky-logo.svg | 4 ---- .svg/pubky-core-logo.svg | 4 ++++ README.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) delete mode 100644 .img/pubky-logo.svg create mode 100644 .svg/pubky-core-logo.svg diff --git a/.img/pubky-logo.svg b/.img/pubky-logo.svg deleted file mode 100644 index 15e92ea..0000000 --- a/.img/pubky-logo.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - - diff --git a/.svg/pubky-core-logo.svg b/.svg/pubky-core-logo.svg new file mode 100644 index 0000000..6dc82d8 --- /dev/null +++ b/.svg/pubky-core-logo.svg @@ -0,0 +1,4 @@ + + + + diff --git a/README.md b/README.md index 9d7637d..f097cb3 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -

pubky

+

pubky

> The Web, long centralized, must decentralize; Long decentralized, must centralize. From 3bb45a5fc93c179f8a136a748e4e548a27d2f420 Mon Sep 17 00:00:00 2001 From: nazeh Date: Fri, 25 Oct 2024 09:49:57 +0300 Subject: [PATCH 3/5] docs: update README.md with overview and features --- README.md | 35 +++++++++++++++++++++++++++++++++-- 1 file changed, 33 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f097cb3..4b1448c 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,39 @@ -

pubky

+

pubky

+ +

+ An open protocol for per-public-key backends for censorship resistant web applications. +

+ +
+

+ + Docs Site + + | + + Rust Client's Docs + + | + + Releases + +

+
+ > The Web, long centralized, must decentralize; Long decentralized, must centralize. +## Overview + +Pubky-core combines a [censorship resistant public-key based alternative to DNS](https://pkarr.org) with conventional, tried and tested web technologies, to keep users in control of their identities and data, while enabling developers to build software with as much availability as web apps, without the costs of managing a central database. + +## Features +- Public key based authentication. +- Public key based 3rd party authorization. +- Key-value store through PUT/GET/DELET HTTP API + pagination. + +## Getting started + > [!WARNING] > Pubky is still under heavy development and should be considered an alpha software. -> > Features might be added, removed, or changed. Data might be lost. From 1f1bbceeef2174964b77b7b57f7641a9c001a800 Mon Sep 17 00:00:00 2001 From: nazeh Date: Fri, 25 Oct 2024 10:20:25 +0300 Subject: [PATCH 4/5] docs: update Getting started section in README.md --- README.md | 27 +++++++++++++++++++++++---- pubky-homeserver/README.md | 2 ++ pubky/README.md | 4 ++++ 3 files changed, 29 insertions(+), 4 deletions(-) create mode 100644 pubky/README.md diff --git a/README.md b/README.md index 4b1448c..ca55a27 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ +

pubky

@@ -20,7 +21,6 @@

- > The Web, long centralized, must decentralize; Long decentralized, must centralize. ## Overview @@ -34,6 +34,25 @@ Pubky-core combines a [censorship resistant public-key based alternative to DNS] ## Getting started -> [!WARNING] -> Pubky is still under heavy development and should be considered an alpha software. -> Features might be added, removed, or changed. Data might be lost. +This repository contains a [Homeserver](./pubky-homeserver), and a [Client](./pubky) (both Rust and JS wasm bindings). +You can a run a local homeserver using `cargo run` with more instructions in the README. +Check the [Examples](./examples) directory for small feature-focesed examples of how to use the Pubky client. + +### JavaScript +If you prefer to use JavaScript in NodeJs/Browser or any runtime with Wasm support, you can either install from npm [`@synonymdev/pubky`](https://www.npmjs.com/package/@synonymdev/pubky) +or build the bindings yourself: +```bash +cd pubky/pkg +npm i +npm run build +``` + +#### Testing +There are unit tests for the JavaScript bindings in both NodeJs and headless web browser, but first you need to run a local temporary Homeserver +```bash +npm run testnet +``` +Then in a different terminal window: +```bash +npm test +``` diff --git a/pubky-homeserver/README.md b/pubky-homeserver/README.md index 7b884d5..f222f7e 100644 --- a/pubky-homeserver/README.md +++ b/pubky-homeserver/README.md @@ -1,5 +1,7 @@ # Pubky Homeserver +A pubky-core homeserver that acts as users' agent on the Internet, providing data availability and more.more.more.more. + ## Usage Use `cargo run` diff --git a/pubky/README.md b/pubky/README.md new file mode 100644 index 0000000..087ffc2 --- /dev/null +++ b/pubky/README.md @@ -0,0 +1,4 @@ +# Pubky + +Rust implementation implementation of [Pubky](https://github.com/pubky/pubky-core) client. + From d864572e2bd6c9026cdd531b8d3fe7d94af9eccb Mon Sep 17 00:00:00 2001 From: nazeh Date: Fri, 25 Oct 2024 10:23:25 +0300 Subject: [PATCH 5/5] docs: add link to js bindings in README.md --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ca55a27..26a0daf 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,3 @@ -

pubky

@@ -18,6 +17,10 @@ Releases + | + + JS bindings +