Skip to content

Commit 4722ef8

Browse files
chore: Update docs
1 parent 477e912 commit 4722ef8

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

docs/FeedProcess.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ https://app.liftlog.online/feed/share?id=aDf00f&name=Liam
4949
The structure of the url being:
5050
`https://app.liftlog.online/feed/share?id=USER_ID&name=Name`
5151

52-
When a user (the follower) clicks this link, it will open directly in the LiftLog app, or in the web app. The app parses out the 2 parameters and displays a message asking if they would like to request to subscribe to the feed. The public key of the client will be fetched with the specified UserID. Note the follower must also have an identity setup prior to making the request. If they accept they create an `InboxMessage` (of type `FollowRequest`) payload consisting of:
52+
When a user (the follower) clicks this link, it will open directly in the LiftLog app. The app parses out the 2 parameters and displays a message asking if they would like to request to subscribe to the feed. The public key of the client will be fetched with the specified UserID. Note the follower must also have an identity setup prior to making the request. If they accept they create an `InboxMessage` (of type `FollowRequest`) payload consisting of:
5353

5454
- An optional name
5555
- The follower's user ID
@@ -131,7 +131,7 @@ sequenceDiagram
131131
### Inbox Message Encryption
132132

133133
Inbox messages are aimed to be small messages which can be encoded and sent to a user with their RSA Public key.
134-
Since RSA has a rather small max paylaod length, these messages are split into chunks, then each chunk is encrypted. These chunks are then sent to the server. When a user requests their inbox messages, they are returned, then immediately deleted from the server. The user can use their private key to decrypt the chunks, then stitch them back together to form the original payload.
134+
Since RSA has a rather small max payload length, these messages are split into chunks, then each chunk is encrypted. These chunks are then sent to the server. When a user requests their inbox messages, they are returned, then immediately deleted from the server. The user can use their private key to decrypt the chunks, then stitch them back together to form the original payload.
135135

136136
### Payload Encryption
137137

docs/PlaintextExport.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Plaintext Export
22

3-
LiftLog supports exporting your data as plaintext. Currently it supports CSV files.
4-
These exports must NOT be used as a backup mechanism, as LiftLog cannot read these CSVs.
3+
LiftLog supports exporting your data as plaintext. Currently it supports CSV and JSON files.
4+
These exports must NOT be used as a backup mechanism, as LiftLog cannot read these plaintext exports.
55

66
To create an export, simply navigate to `Settings -> Export, Backup, and Restore -> Plaintext Export`.
77
Here, you can export a CSV or JSON file which contains your workout data. Sets which have not been completed are not included in the export.

0 commit comments

Comments
 (0)