first commit

2025-12-30 04:34:38 -05:00
commit 637b67d971
11 changed files with 2170 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,119 @@
+# CrowdProof Observe
+
+A Firefox browser extension for quickly submitting observations to your CrowdProof instance.
+
+## Features
+
+- **Sidebar Interface** - Submit observations without leaving your current page
+- **Multiple Observation Types** - Photos, URLs, emails (.msg/.eml), logs, and statements
+- **Quick Capture** - Right-click images or links to send directly to CrowdProof
+- **Paste to Submit** - Paste screenshots directly from clipboard
+- **Access Management** - Set public access levels for your observations
+- **Theme Integration** - Adapts to your Firefox theme
+
+## Installation
+
+### From Firefox Add-ons (Recommended)
+Visit the [Firefox Add-ons page](#) and click "Add to Firefox".
+
+### Manual Installation (Development)
+1. Open Firefox and navigate to `about:debugging`
+2. Click "This Firefox" in the sidebar
+3. Click "Load Temporary Add-on"
+4. Select the `manifest.json` file from this directory
+
+## Usage
+
+### Initial Setup
+1. Click the CrowdProof Observe icon in the toolbar to open the sidebar
+2. The extension defaults to `https://crowdproof.silogroup.org`
+3. To use a different instance, click "Settings" and enter your server URL
+4. Log in with your CrowdProof credentials
+
+### Submitting Observations
+
+**Photos:**
+- Select a file using the file picker, OR
+- Click the paste zone and press Ctrl+V to paste from clipboard, OR
+- Right-click any image on a webpage and select "Send Image to CrowdProof"
+
+**URLs:**
+- Click "Capture Current Page" to grab the active tab's URL, OR
+- Enter a URL manually, OR
+- Right-click any link and select "Send Link to CrowdProof"
+
+**Emails:**
+- Select a .msg or .eml file, OR
+- Drag and drop an email file onto the drop zone
+
+**Logs & Statements:**
+- Fill in the form fields and submit
+
+### Managing Access
+Click the "Access" button to view your observations and set public access levels:
+- **None** - Only explicitly added users can access
+- **Editor** - All active CrowdProof users can view and edit
+- **Viewer** - All active CrowdProof users can view only
+
+## Development
+
+### Project Structure
+```
+crowdproof-observe/
+├── manifest.json        # Extension manifest
+├── background/
+│   └── background.js    # Context menu and background tasks
+├── sidebar/
+│   ├── sidebar.html     # Sidebar UI structure
+│   ├── sidebar.css      # Sidebar styles
+│   └── sidebar.js       # Sidebar logic
+├── options/
+│   ├── options.html     # Options page
+│   └── options.js       # Options logic
+├── icons/               # Extension icons
+├── README.md            # This file
+└── AMO.md               # Firefox Add-ons submission info
+```
+
+### Building
+No build step required. The extension runs directly from source.
+
+### Testing
+1. Load the extension temporarily via `about:debugging`
+2. Make changes to source files
+3. Click "Reload" in `about:debugging` to apply changes
+
+### Packaging
+```bash
+cd crowdproof-observe
+zip -r crowdproof-observe.zip . -x "*.git*" -x "*.md"
+```
+
+## Permissions
+
+| Permission | Purpose |
+|------------|---------|
+| `storage` | Store configured server URL |
+| `activeTab` | Capture current page URL/title |
+| `cookies` | Maintain server authentication |
+| `theme` | Match Firefox theme colors |
+| `contextMenus` | Right-click menu integration |
+| `menus` | Access clicked elements for capture |
+| `<all_urls>` | Connect to user-configured servers |
+
+## Privacy
+
+- No data collection or third-party transmission
+- Communicates only with your configured CrowdProof server
+- No analytics or tracking
+
+See [AMO.md](AMO.md) for the full privacy policy.
+
+## Support
+
+- **Email:** crowdproof-support@silogroup.org
+- **Homepage:** https://crowdproof.silogroup.org
+
+## License
+
+Copyright SILO GROUP. All rights reserved.