Skip to content

Commit d6bd2b9

Browse files
authored
Update README.md
1 parent 46ce5cf commit d6bd2b9

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ZKE method
77

88
This repository contains the client-side encryption code that powers FileShot.io's zero-knowledge encryption feature. Files are encrypted entirely in your browser before upload, ensuring that even FileShot's servers cannot decrypt your files.
99

10-
## 🔒 What is Zero-Knowledge Encryption?
10+
What is Zero-Knowledge Encryption?
1111

1212
Zero-knowledge encryption means that **we cannot decrypt your files**, even if we wanted to. The encryption happens entirely in your browser using the Web Crypto API, and we never receive your encryption key or password.
1313

@@ -19,7 +19,7 @@ Zero-knowledge encryption means that **we cannot decrypt your files**, even if w
1919
-**No server access** - We cannot decrypt your files, even with a court order
2020
-**Open source** - Review the code yourself
2121

22-
## 🚀 Quick Start
22+
## Quick Start
2323

2424
### Try the Demo
2525

@@ -52,15 +52,15 @@ Zero-knowledge encryption means that **we cannot decrypt your files**, even if w
5252
</script>
5353
```
5454

55-
## 📖 How It Works
55+
## How It Works
5656

5757
1. **Key Generation**: Your browser generates a random salt and derives an encryption key from your password using PBKDF2
5858
2. **Encryption**: Your file is encrypted using AES-256-GCM before upload
5959
3. **Upload**: Only the encrypted data is sent to FileShot's servers
6060
4. **Storage**: We store encrypted blobs that we cannot decrypt
6161
5. **Download**: Recipients decrypt files in their browser using the password you shared
6262

63-
## 🔐 Security Details
63+
## Security Details
6464

6565
- **Algorithm**: AES-256-GCM (Galois/Counter Mode)
6666
- **Key Derivation**: PBKDF2 with SHA-256
@@ -69,7 +69,7 @@ Zero-knowledge encryption means that **we cannot decrypt your files**, even if w
6969
- **IV Length**: 12 bytes (96 bits) for GCM
7070
- **Key Length**: 256 bits
7171

72-
## 📁 File Structure
72+
## File Structure
7373

7474
```
7575
fileshot-zke/
@@ -79,7 +79,7 @@ fileshot-zke/
7979
└── LICENSE # MIT License
8080
```
8181

82-
## 🧪 Testing
82+
## Testing
8383

8484
Open `demo.html` in a modern browser to test the encryption implementation. The demo allows you to:
8585

@@ -88,7 +88,7 @@ Open `demo.html` in a modern browser to test the encryption implementation. The
8888
- Decrypt files with the correct password
8989
- Verify that incorrect passwords fail
9090

91-
## 📝 API Reference
91+
## API Reference
9292

9393
### `zeroKnowledgeEncrypt(file, password)`
9494

@@ -123,27 +123,27 @@ Decrypts a file in the browser.
123123

124124
**Returns:** Promise resolving to a Blob containing the decrypted file.
125125

126-
## ⚠️ Important Security Notes
126+
## Important Security Notes
127127

128128
1. **Password Strength**: Use a strong, unique password for each file
129129
2. **Password Sharing**: Share passwords through a secure channel (not via FileShot)
130130
3. **Password Loss**: If you lose your password, the file cannot be recovered
131131
4. **Browser Security**: Ensure your browser and system are secure and up-to-date
132132
5. **HTTPS Only**: Only use this on HTTPS connections in production
133133

134-
## 🔍 Verification
134+
## Verification
135135

136136
This code is used by FileShot.io. You can verify:
137137

138138
1. The code served on FileShot.io matches this repository
139139
2. Encryption happens client-side (check Network tab in DevTools)
140140
3. The encryption key never leaves your browser
141141

142-
## 📄 License
142+
## License
143143

144144
MIT License - See [LICENSE](LICENSE) file for details.
145145

146-
## 🤝 Contributing
146+
## Contributing
147147

148148
We welcome security reviews and improvements! Please:
149149

@@ -152,7 +152,7 @@ We welcome security reviews and improvements! Please:
152152
3. Submit issues or pull requests
153153
4. Report security vulnerabilities responsibly
154154

155-
## 🔒 Security Policy
155+
## Security Policy
156156

157157
If you discover a security vulnerability, please email **fileshot.adm@gmail.como** instead of opening a public issue.
158158

0 commit comments

Comments
 (0)