~arsen/irc-discord-bridgebot

630c9f0d9780d0e635df72b5d8ee682379f5e5dc — Arsen Arsenović 1 year, 9 months ago 1391017
readme: correct use of pre and code
1 files changed, 9 insertions(+), 8 deletions(-)

M README.rst
M README.rst => README.rst +9 -8
@@ 9,7 9,7 @@ A puppet connection based bidirectional Discord to IRC bridge.

CI
--
Latest ``master`` build available `here <https://cdn.aarsen.me/builds/irc-discord-bridgebot/master>`_
Latest :code:`master` build available `here <https://cdn.aarsen.me/builds/irc-discord-bridgebot/master>`_

Unsupported features
--------------------


@@ 24,17 24,17 @@ Features in the TODO

Special setup instructions
--------------------------
The program requires ``CAP_NET_RAW`` and ``CAP_NET_BIND_SERVICE`` and a full
The program requires :code:`CAP_NET_RAW` and :code:`CAP_NET_BIND_SERVICE` and a full
IPv6 /64 dedicated to it. An additional privsep helper will be provided in the
near future under ``privsep/``.
near future under :code:`privsep/`.

The bridge now serves a HTTP server locally that you should just
reverse proxy via nginx. See the example config.

Environment
-----------
``IDB_CONFIG``
        Path to the config file (defaults to ``idb.toml``).
:code:`IDB_CONFIG`
        Path to the config file (defaults to :code:`idb.toml`).

IMPORTANT NOTE
--------------


@@ 44,12 44,13 @@ Do report any issues if you decide to deploy.
Contributing and reporting issues
---------------------------------
Reach out to `my mailing list`_, please prefix your subject line with
``irc-discord-bridgebot`` or ``IDB``, and use
``format.subjectprefix = PATCH irc-discord-bridgebot`` for patches.
:code:`irc-discord-bridgebot` or :code:`IDB`, and use
:code:`format.subjectprefix = PATCH irc-discord-bridgebot` for patches.

.. _`my mailing list`: https://lists.sr.ht/~arsen/public-inbox

License
-------
Licensed under the GNU Affero General Public License, version 3. The bot
accepts a ``license`` private message to get information about the source code.
accepts a :code:`license` private message to get information about the source
code.