Merge pull request #12 from crosspoint-reader/documentation-and-scripts

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 CrossPoint Reader
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,14 @@
+.PHONY: install list remove
+
+PLUGIN_DIR = crosspoint_reader
+PLUGIN_NAME = CrossPoint Reader
+CALIBRE = /Applications/calibre.app/Contents/MacOS/calibre-customize
+
+install:
+	$(CALIBRE) -b $(PLUGIN_DIR)
+
+list:
+	$(CALIBRE) -l
+
+remove:
+	$(CALIBRE) -r "$(PLUGIN_NAME)"

README.md

@@ -0,0 +1,47 @@
+# Calibre Plugins
+
+Calibre plugins for [CrossPoint Reader](https://github.com/crosspoint-reader).
+
+## Plugins
+
+### CrossPoint Reader
+
+A wireless device plugin that uploads EPUB files to CrossPoint Reader over WebSocket. The plugin auto-discovers devices on the local network via UDP broadcast.
+
+See [crosspoint_reader/README.md](crosspoint_reader/README.md) for protocol details and configuration.
+
+## Installation
+
+Download the latest release from the [releases page](https://github.com/crosspoint-reader/calibre-plugins/releases), then in Calibre: **Preferences > Plugins > Load plugin from file**.
+
+## Development
+
+### Setup
+
+```sh
+# Build and install the plugin into Calibre
+make install
+
+# List all installed plugins
+make list
+
+# Remove the plugin
+make remove
+```
+
+See [`calibre-customize` docs](https://manual.calibre-ebook.com/generated/en/calibre-customize.html) for more options.
+
+### Project structure
+
+```
+crosspoint_reader/
+  __init__.py   # Plugin entry point
+  driver.py     # Device driver (discovery, upload, delete)
+  ws_client.py  # WebSocket client and UDP discovery
+  config.py     # Settings UI and preferences
+  log.py        # Logging utilities
+```
+
+## License
+
+[MIT](LICENSE)