broadfield-dev commited on
Commit
4b54262
·
verified ·
1 Parent(s): c1a64ad

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +25 -1
README.md CHANGED
@@ -9,4 +9,28 @@ app_file: app.py
9
  pinned: false
10
  ---
11
 
12
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
9
  pinned: false
10
  ---
11
 
12
+ ---
13
+ title: KeyLock Image Creator
14
+ sdk: gradio
15
+ ---
16
+
17
+ # 🏭 KeyLock Image Creator
18
+
19
+ This application provides a user-friendly interface to create secure, encrypted PNG images compatible with the KeyLock ecosystem.
20
+
21
+ It is designed to work with one or more "Decoder API" services. By providing a JSON configuration, you can easily select which service you want to encrypt data for, and this app will automatically use the correct public key.
22
+
23
+ ## How to Use
24
+
25
+ 1. **Prepare a JSON Configuration:** Create a JSON file or string that contains a list of your decoder services. Each service in the list must be an object with three keys:
26
+ - `name`: A user-friendly name for the service (e.g., "My Production API").
27
+ - `link`: A URL to the service for reference.
28
+ - `public_key`: The full PEM-formatted public key string for that service.
29
+
30
+ 2. **Paste the Configuration:** Paste your JSON into the "JSON Configuration" textbox in the app. The "Select Decoder Service" dropdown will automatically populate with the names of the services you provided.
31
+
32
+ 3. **Enter Your Secret Data:** In the "Secret Data" textbox, enter the information you want to encrypt, one key-value pair per line (e.g., `USERNAME: my_user`).
33
+
34
+ 4. **Select a Service:** Choose the target service from the dropdown menu.
35
+
36
+ 5. **Create Image:** Click the "Create Encrypted Image" button. The app will generate a new PNG with your data securely embedded and encrypted for the selected service. You can then preview and download the image.