From 91f7b1ebdeea1383dc52799b37274703731b82ef Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Wed, 9 Dec 2020 22:09:32 +0100 Subject: [PATCH] Fixed typo in readme --- README.html | 17 ++++++++--------- README.md | 4 ++-- 2 files changed, 10 insertions(+), 11 deletions(-) diff --git a/README.html b/README.html index 2ad08fe..2f83335 100644 --- a/README.html +++ b/README.html @@ -745,8 +745,8 @@ pre {
  • Payload
    • @@ -766,16 +766,16 @@ pre {
  • The Payload part is a list containing four items:
      -
    1. The Timestamp is double-precision floating point number representing the number of seconds since the UNIX epoch.
      2. -
    2. The Title is an optional title for the message
      3. +
    3. The Timestamp is a double-precision floating point number representing the number of seconds since the UNIX epoch.
    4. The Content is the optional content or body of the message
      5. +
    5. The Title is an optional title for the message
    6. The Fields is an optional dictionary
  • -

    The Title, Content and Fields parts must be included in the message structure, but can be left empty.

    +

    The Content, Title and Fields parts must be included in the message structure, but can be left empty.

  • The Fields part can be left empty, or contain a dictionary of any structure or depth.

    @@ -805,14 +805,13 @@ pre { The LXM Router

    The LXM Router handles transporting messages over a Reticulum network, managing delivery receipts, outbound and inbound queues, and is the point of API interaction for client programs. The LXM Router also implements functionality for acting as an LXMF Propagation Node.

    Programatically, using the LXM Router to send a message is as simple as:

    -
    import LXMF
+
    import LXMF
 
-lxm_router = LXMF.LXMRouter()
+lxm_router = LXMF.LXMRouter()
 
-message = LXMF.LXMessage(destination, source, "This is a short, simple message.")
+message = LXMF.LXMessage(destination, source, "This is a short, simple message.")
 
-lxm_router.handle_outbound(message)
-
    
+lxm_router.handle_outbound(message)

    The LXM Router then handles the heavy lifting, such as message packing, encryption, delivery confirmation, path lookup, routing, retries and failure notifications.

    Transport Encryption

    diff --git a/README.md b/README.md index c81a5f0..b90ae1a 100644 --- a/README.md +++ b/README.md @@ -29,8 +29,8 @@ LXMF messages are stored in a simple and efficient format, that's easy to parse - The __Signature__ field is a RSA signature of the __Destination__, __Source__, __Payload__ and __message-id__ - The __Payload__ part is a list containing four items: 1. The __Timestamp__ is a double-precision floating point number representing the number of seconds since the UNIX epoch. - 2. The __Content__ is an optional title for the message - 3. The __Title__ is the optional content or body of the message + 2. The __Content__ is the optional content or body of the message + 3. The __Title__ is an optional title for the message 4. The __Fields__ is an optional dictionary 3. The __Content__, __Title__ and __Fields__ parts must be included in the message structure, but can be left empty.