Skip to content

Commit

Permalink
feat: add how-to-use in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
yukimochi committed Mar 2, 2023
1 parent 0a6a018 commit 9054a12
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,16 @@ JOB_CONCURRENCY: 50
- RELAY_ICON
- RELAY_IMAGE

## How to Use Relay (for Relay Customers)

### Mastodon, Misskey and their forks

Subscribe this inbox `https://<your-relay-server-address>/inbox`

### Pleroma and their forks

Follow this actor `https://<your-relay-server-address>/actor`

## [Document](https://github.com/yukimochi/Activity-Relay/wiki)

See [GitHub wiki](https://github.com/yukimochi/Activity-Relay/wiki) to build / install / control relay.
Expand Down

0 comments on commit 9054a12

Please sign in to comment.