docs: update Getting started section in README.md

This commit is contained in:
nazeh
2024-10-25 10:20:25 +03:00
parent 3bb45a5fc9
commit 1f1bbceeef
3 changed files with 29 additions and 4 deletions

View File

@@ -1,3 +1,4 @@
<h1 align="center"><a href="https://pubky.org/"><img alt="pubky" src="./.svg/pubky-core-logo.svg" width="200" /></a></h1>
<h3 align="center">
@@ -20,7 +21,6 @@
</h3>
</div>
> 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
```

View File

@@ -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`

4
pubky/README.md Normal file
View File

@@ -0,0 +1,4 @@
# Pubky
Rust implementation implementation of [Pubky](https://github.com/pubky/pubky-core) client.