Commit 72f1fbd5 authored by Eugen Rochko's avatar Eugen Rochko

Update README.md

parent b776c28d
Pipeline #140 passed with stage
in 45 seconds
# pub-relay
pub-relay
=========
TODO: Write a description here
...is a service-type ActivityPub actor that will re-broadcast anything sent to it to anyone who subscribes to it.
## Installation
![](https://i.imgur.com/5q8db54.jpg)
TODO: Write installation instructions here
Endpoints:
## Usage
- `GET /actor`
- `POST /inbox`
- `GET /.well-known/webfinger`
TODO: Write usage instructions here
Operations:
## Development
- Send a Follow activity to the inbox to subscribe
(Object: `https://www.w3.org/ns/activitystreams#Public`)
- Send an Undo of Follow activity to the inbox to unsubscribe
(Object of object: `https://www.w3.org/ns/activitystreams#Public`)
- Send anything else to the inbox to broadcast it
(Supported types: `Create`, `Update`, `Delete`, `Announce`, `Undo`)
TODO: Write development instructions here
Requirements:
## Contributing
- All requests must be HTTP-signed with a valid actor
- Only payloads that contain a linked-data signature will be re-broadcast
- Only payloads addressed to `https://www.w3.org/ns/activitystreams#Public` will be re-broadcast
## Installation
Download the binaries.
## Usage
1. Fork it (<https://github.com/your-github-user/pub-relay/fork>)
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
TODO
## Contributors
- [your-github-user](https://github.com/your-github-user) RX14 - creator, maintainer
- [RX14](https://source.joinmastodon.org/RX14) creator, maintainer
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment