Skip to content

Commit

Permalink
fix: updates README
Browse files Browse the repository at this point in the history
  • Loading branch information
tuddman committed Apr 3, 2024
1 parent 9ea77be commit 22dd4b2
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

A simple, asynchronous file server provided as an example to support XMTP Message History transfers.

Running this server allows XMTP service providers to provide the ability for users to securely upload message history bundles via a `POST` request and retrieve them via a `GET` request using a unique ID assigned upon upload. It is expected that these uploaded bundles should be: encrypted, short-lived, non-guessable, with scoped access to only authorized parties.
Running this server allows XMTP service providers to provide the ability for users to securely upload message history bundles via a `POST` request and retrieve them via a `GET` request from another authorized app or device, using a unique ID assigned upon upload. It is expected that these uploaded bundles should be: encrypted, short-lived, non-guessable, with scoped access to only authorized parties.

## Getting Started

Expand All @@ -11,7 +11,7 @@ Running this server allows XMTP service providers to provide the ability for use
Ensure you have the following installed:

- Rust and Cargo. You can install them both from [https://rustup.rs](https://rustup.rs)
- To run the example uploader, ensure python is installed on your system.
- To run the example uploader, ensure python is correctly installed on your system.

Set the `SECRET_KEY` environment variable.

Expand Down

0 comments on commit 22dd4b2

Please sign in to comment.