Skip to content
This repository was archived by the owner on Mar 10, 2026. It is now read-only.

Commit c32e405

Browse files
authored
Update README.md
1 parent 660c5cf commit c32e405

File tree

1 file changed

+31
-1
lines changed

1 file changed

+31
-1
lines changed

README.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,34 @@
1818
- **Metadata‑Free**: Random 16‑digit session IDs, no server contacts, no logs, no server‑side metadata, enforced passwordless authentication. Everything is local, encrypted, and ephemeral.
1919

2020
## ⚠️ Disclaimer
21-
Coldwire is experimental. While it enforces paranoid‑level security features, the protocol and codebase are under active development. **Do not** use for production‑grade secrecy until a formal audit is complete.
21+
While Coldwire enforces paranoid‑level security features, the protocol, and codebase are under active development.
22+
23+
**Do not** use for production‑grade secrecy until an formal audit is complete.
24+
25+
## Installation
26+
### Dependecies
27+
- liboqs-python
28+
- git
29+
- CMake
30+
- C compiler
31+
- Python 3
32+
33+
Install [liboqs-python](https://github.com/open-quantum-safe/liboqs-python/) by running:
34+
```sh
35+
git clone --depth=1 https://github.com/open-quantum-safe/liboqs-python
36+
cd liboqs-python
37+
pip install .
38+
```
39+
40+
Clone Coldwire repositioary and install `requirements.txt` by running:
41+
```
42+
git clone https://github.com/Freedom-Club-FC/Coldwire
43+
cd Coldwire
44+
pip install -r requirements.txt
45+
```
46+
47+
## Usage
48+
Run Coldwire's GUI using:
49+
```sh
50+
python3 main.py
51+
```

0 commit comments

Comments
 (0)