summaryrefslogtreecommitdiff
path: root/lib/mix/tasks/relay_follow.ex
diff options
context:
space:
mode:
Diffstat (limited to 'lib/mix/tasks/relay_follow.ex')
-rw-r--r--lib/mix/tasks/relay_follow.ex7
1 files changed, 7 insertions, 0 deletions
diff --git a/lib/mix/tasks/relay_follow.ex b/lib/mix/tasks/relay_follow.ex
index ac6f20924..4d57c6bca 100644
--- a/lib/mix/tasks/relay_follow.ex
+++ b/lib/mix/tasks/relay_follow.ex
@@ -4,6 +4,13 @@ defmodule Mix.Tasks.RelayFollow do
alias Pleroma.Web.ActivityPub.Relay
@shortdoc "Follows a remote relay"
+ @moduledoc """
+ Follows a remote relay
+
+ Usage: ``mix relay_follow <relay_url>``
+
+ Example: ``mix relay_follow https://example.org/relay``
+ """
def run([target]) do
Mix.Task.run("app.start")