docs: update README.md with overview and features

This commit is contained in:
nazeh
2024-10-25 09:49:57 +03:00
parent 0b6c0b88e8
commit 3bb45a5fc9

View File

@@ -1,8 +1,39 @@
<h1 align="center"><a href="https://pubky.org/"><img alt="pubky" src="./.svg/pubky-core-logo.svg" width="100" /></a></h1>
<h1 align="center"><a href="https://pubky.org/"><img alt="pubky" src="./.svg/pubky-core-logo.svg" width="200" /></a></h1>
<h3 align="center">
An open protocol for per-public-key backends for censorship resistant web applications.
</h3>
<div align="center">
<h3>
<a href="https://pubky.github.io/pubky-core/">
Docs Site
</a>
<span> | </span>
<a href="https://docs.rs/pubky">
Rust Client's Docs
</a>
<span> | </span>
<a href="https://github.com/pubky/pubky-core/releases">
Releases
</a>
</h3>
</div>
> 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.