Skip to content

Commit

Permalink
docs: Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Goshawk committed Oct 23, 2024
1 parent 6558a4f commit 6e5395a
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@

# Storage server

### This server stores files in logical buckets. Each bucket maintains a Merkle tree, which enables on-demand Merkle proofs.
#### This server stores files in logical buckets. Each bucket maintains a Merkle tree, which enables on-demand Merkle proofs.

REST APIs

- File Upload `POST /upload/:bucket_id/:file_name`
- Upload a file to a specific bucket

- Complete Upload `POST /complete_upload/:bucket_id`
- Finalize a bucket upload
- Finalize a bucket upload. This instructs the server to generate the Merkle Tree for uploaded files in a specified bucket.

- File request `GET /file/:bucket_id/:file_index`
- Retrieve a file by its index from a specified bucket.
Expand Down Expand Up @@ -38,17 +38,15 @@ REST APIs
verify_merkle_proof_100000 time: [1.2044 µs 1.2055 µs 1.2069 µs]
```



## Example HTTP Client

Features:

- Uploads all files from a source folder to the server in encrypted form.
- Maintains a Merkle root of the uploaded files.
- Requests both a file and its Merkle proof from the server.
- Upload **concurrently** all files from a source folder to the server in encrypted form.
- Maintain a Merkle root of the successfully uploaded files.
- Request both a file and its Merkle proof from the server.
- If the proof is valid, the client decrypts the file and stores it locally.
- Simple prompt
- Simple UI prompt

## How to run

Expand Down

0 comments on commit 6e5395a

Please sign in to comment.