🆕 Add license and code

LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 @steelbrain
+
+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.

README.md

@@ -1,3 +1,35 @@
 # ffmpeg over IP
 
-TODO
+Connect to remote ffmpeg servers. Are you tired of unsuccessfully trying to pass your GPU through to a docker
+container running in a VM? So was I! `ffmpeg-over-ip` allows you to run an ffmpeg server on a machine with access
+to a GPU (Linux, Windows, or Mac) and connect to it from a remote machine. The only thing you need is Node.js
+installed and a shared filesystem (could be NFS, SMB, etc.) between the two machines.
+
+## Installation
+
+`ffmpeg-over-ip` consists of two main parts, the server and the client. Both are packed neatly into single JS
+files. You can download these from the [npm interface][1] or by `npm install ffmpeg-over-ip` and then copying
+them to the relevant places. You don't need any `node_modules` to run the server or the client.
+
+## Configuration
+
+The server and the client are both configured using JSONC (JSON with comments) configuration files. The paths
+of these files can be flexible. To identify which paths are being used, you can invoke either with `--debug-print-search-paths`.
+
+Template/example configuration files are provided in this repository for your convinience. Unless the server and the client
+share the same filesystem, you may have to specify `pathMappings` in the server configuration file.
+
+## Usage
+
+Both the server and the client files are executable, so long as there is a Node.js installation available. If you intend
+to use this in a docker container, you can directly mount the client file to where the container would expect a regular
+ffmpeg executable to be, ie `docker run -v ./path/to/client.js:/usr/lib/jellyfin-ffmpeg/ffmpeg ...`.
+
+The server and the client communicate commands over HTTP, so make sure that whatever port you specify on the server is
+allowed through the firewall.
+
+## License
+
+The contents of this project are licensed under the terms of the MIT License.
+
+[1]:https://www.npmjs.com/package/ffmpeg-over-ip?activeTab=code

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ffmpeg-over-ip",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "description": "Connect to remote ffmpeg servers",
   "main": "index.js",
   "type": "module",