Skip to content

Commit

Permalink
docs: add recommendations for writing watchers
Browse files Browse the repository at this point in the history
  • Loading branch information
brayo-pip committed Jul 10, 2024
1 parent c4fe5e0 commit 4765f70
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/examples/writing-watchers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,5 @@ This example will describe how to:

.. literalinclude:: client.rs

It is recommend to follow conventions and use the `aw-watcher-<name>` naming scheme for your watcher.
It is also recommended for watchers to accept a `--testing` flag and a `--port <port>` flag to allow users to specify the port to connect to.

0 comments on commit 4765f70

Please sign in to comment.