From b95c60972f285a335ce6682f8ed3333f1c158cee Mon Sep 17 00:00:00 2001
From: Yiyao Yu <yuydevel@protonmail.com>
Date: Sat, 26 Oct 2024 21:49:45 -0700
Subject: [PATCH] Added initial README.md

---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5d4ddd6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+WebRTC-PoC
+==========
+
+WebRTC fingerprint authentication proof-of-concept.
+
+Build Instructions
+------------------
+
+```bash
+$ npm install
+$ npm start
+```
+
+PoC will be available at `http://0.0.0.0:3000`.
+
+Key Components
+--------------
+
+This PoC demonstrates the possibility of the following:
+1. Generate, store, and load a specific RTCCertfiicate.
+2. Upload the certificate fingerprint to a webserver.
+3. Establish a WebRTC session between two browser instances, verify the
+certificate used has been registered and terminate the connection if not.
+
+Currently this only runs on Chrome due to client-side JS calling a
+`RTCCertificate.getfingerprint()` function. However, it shouldn't be too
+hard creating a shim for this function to work with FireFox, at the cost of
+some performance issues (and potentially making the function async).
+
+