philipp-zettl commited on
Commit
cc5fe98
Β·
verified Β·
1 Parent(s): 94e62f0

Initial Space setup: README with OAuth config

Browse files
Files changed (1) hide show
  1. README.md +26 -7
README.md CHANGED
@@ -1,12 +1,31 @@
1
  ---
2
- title: Vrom Hub
3
- emoji: πŸƒ
4
- colorFrom: red
5
- colorTo: gray
6
  sdk: gradio
7
- sdk_version: 6.13.0
8
  app_file: app.py
9
- pinned: false
 
 
 
10
  ---
11
 
12
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ title: "🧩 vROM Hub"
3
+ emoji: 🧩
4
+ colorFrom: purple
5
+ colorTo: blue
6
  sdk: gradio
7
+ sdk_version: "6.13.0"
8
  app_file: app.py
9
+ pinned: true
10
+ hf_oauth: true
11
+ hf_oauth_scopes:
12
+ - email
13
  ---
14
 
15
+ # 🧩 vROM Hub
16
+
17
+ Browse, submit, and manage [vROM](https://github.com/philsupertramp/vecdb-wasm) packages β€” pre-computed vector knowledge bases for in-browser semantic search.
18
+
19
+ ## Features
20
+
21
+ - **πŸ“‹ Browse** β€” View all published vROMs in the registry
22
+ - **βž• Submit** β€” Request a new vROM from documentation URLs
23
+ - **πŸ” Admin** β€” Approve/reject submissions, trigger builds
24
+
25
+ ## How it works
26
+
27
+ 1. **Submit** documentation URLs via the form
28
+ 2. An **admin reviews** and approves the request
29
+ 3. The backend **chunks β†’ embeds β†’ builds HNSW** index
30
+ 4. The vROM is **published** to the [registry](https://huggingface.co/datasets/philipp-zettl/vrom-registry)
31
+ 5. Load it in the browser: `await memory.mount('your-vrom-id')`