Git-Mirrors/LXMF
1
0
Fork 0
mirror of https://github.com/markqvist/LXMF.git synced 2024-12-25 23:29:25 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Mark Qvist 2020-05-01 21:07:24 +02:00 committed by GitHub
parent 64f12b2857
commit 4b81a8d239
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -14,8 +14,8 @@ LXMF messages are stored in a simple and efficient format, that's easy to parse
- RSA Signature - RSA Signature
- Payload - Payload
- Timestamp - Timestamp
- Title
- Content - Content
- Title
- Fields - Fields
##### And these rules: ##### And these rules:
@ -28,12 +28,12 @@ LXMF messages are stored in a simple and efficient format, that's easy to parse
- The __Destination__ and __Source__ fields are Reticulum destination hashes - The __Destination__ and __Source__ fields are Reticulum destination hashes
- The __Signature__ field is a RSA signature of the __Destination__, __Source__, __Payload__ and __message-id__ - The __Signature__ field is a RSA signature of the __Destination__, __Source__, __Payload__ and __message-id__
- The __Payload__ part is a list containing four items: - 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. 1. The __Timestamp__ is a double-precision floating point number representing the number of seconds since the UNIX epoch.
2. The __Title__ is an optional title for the message 2. The __Content__ is an optional title for the message
3. The __Content__ is the optional content or body of the message 3. The __Title__ is the optional content or body of the message
4. The __Fields__ is an optional dictionary 4. The __Fields__ is an optional dictionary
3. The __Title__, __Content__ and __Fields__ parts must be included in the message structure, but can be left empty. 3. The __Content__, __Title__ and __Fields__ parts must be included in the message structure, but can be left empty.
4. The __Fields__ part can be left empty, or contain a dictionary of any structure or depth. 4. The __Fields__ part can be left empty, or contain a dictionary of any structure or depth.
@ -103,4 +103,4 @@ If you want to try out LXMF, you can install it with pip:
```bash ```bash
pip3 install lxmf pip3 install lxmf
``` ```