Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mattholy committed Jan 22, 2024
1 parent 75ad106 commit dd50d68
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 7 deletions.
39 changes: 32 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,38 @@
<div align="center">

<img src="./docs/logo.png" alt="Wand" width="300"/>

**Wand is yet another open-source ActivityPub relay, in Python. 😘**

----

[![codecov](https://codecov.io/github/mattholy/wand/graph/badge.svg?token=E9FLI822U9)](https://codecov.io/github/mattholy/wand)

----

[🇬🇧English](README.md) | [🇨🇳中文](README_zh-CN.md)

----

<img src="./docs/fedi.png" height="100"/>

</div>
<p align="center">
<img src="./docs/logo.png" alt="Wand" width="300"/>
</p>

# Wand
Wand is an ActivityPUB relay made with Python
----

<div>

## Philosophy & Features

### Connecting through the Fediverse



</div>



[English](README.md) | [中文](README_zh-CN.md)
<div style="clear: both;"></div>

## Getting Start
ActivityPUB **need** to connect through https while Wand is a naive python ASGI.
Expand Down Expand Up @@ -104,7 +129,7 @@ For the green hand, there is a short guide.
- The `publickey.asc` is your gpg public key. It is safe to share with Wand and anywhere else you like (e.g. Github)
- Be make sure to store your private key in a safe place (e.g. YubiKey)
## Dev
## Dev & Contribute
Just clone this repo.
### Frontend
Expand Down
Binary file added docs/fedi.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit dd50d68

Please sign in to comment.