Skip to content

Commit faa0b19

Browse files
committed
Update README.md
1 parent 2b54e3e commit faa0b19

File tree

1 file changed

+5
-13
lines changed

1 file changed

+5
-13
lines changed

README.md

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
1-
# Secure Document Share
1+
# Secure Document Share - Backend
22

33
## Overview
4-
Secure document share is a viewing web application that encrypts documents before uploading them. Users can share documents via unique URLs, and only those with the correct decryption key can access the contents.
4+
This is the backend for our Secure Document Share App.
55

66
## Features
7-
- 🔒 **End-to-end encryption**: Documents are encrypted before uploading and can only be decrypted by authorized users.
8-
- 📤 **Secure file upload**: PDFs can be uploaded and stored securely.
9-
- 📡 **WebSocket-based updates**: Real-time updates through WebSockets.
7+
tbd
108

119
### Prerequisites
1210
Ensure you have the following installed:
@@ -16,8 +14,8 @@ Ensure you have the following installed:
1614
### Setup
1715
1. **Clone the repository**
1816
```sh
19-
git clone https://github.com/H2-invent/secure-document-share.git
20-
cd secure-document-share
17+
git clone https://github.com/H2-invent/secure-document-share-backend.git
18+
cd secure-document-share-backend
2119
```
2220
2. **Install dependencies**
2321
```sh
@@ -32,9 +30,3 @@ Ensure you have the following installed:
3230
```sh
3331
node server.mjs --port=<port>
3432
```
35-
36-
## Contributing
37-
Feel free to submit issues or pull requests to improve the project.
38-
39-
## License
40-
This project is licensed under the BSL-2 License.

0 commit comments

Comments
 (0)