From 3df3ecb963c188795053a0e93db0776ee13a43d5 Mon Sep 17 00:00:00 2001
From: Will Freeman <hohosanta@me.com>
Date: Mon, 6 Jan 2025 15:50:05 -0700
Subject: [PATCH] add readme, update run scripts

---
 README.md    | 41 +++++++++++++++++++++++++++++++++++++++++
 package.json |  4 +++-
 2 files changed, 44 insertions(+), 1 deletion(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ea8f703
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# ALPR Leaks
+
+Log license plates, vehicle make, vehicle color, and vehicle model to a CSV along with a JPEG image of the vehicle from Motorola ALPRs exposed to the public internet.
+
+This script is preloaded with 3 IP addresses, but more can be added.
+
+## Running Locally
+
+To run this project locally, follow these steps:
+
+### Prerequisites
+
+Make sure you have the following installed on your machine:
+- [Node.js](https://nodejs.org/) (version 14 or higher)
+- [npm](https://www.npmjs.com/) (version 6 or higher)
+
+### Installation
+
+1. Clone the repository:
+  ```sh
+  git clone https://github.com/frillweeman/alprleaks.git
+  ```
+2. Navigate to the project directory:
+  ```sh
+  cd alprleaks
+  ```
+3. Install the dependencies:
+  ```sh
+  npm install
+  ```
+
+### Running the Project
+
+1. Compile the TypeScript files:
+  ```sh
+  npm run build
+  ```
+2. Start the application:
+  ```sh
+  npm start
+  ```
diff --git a/package.json b/package.json
index 00fc2e2..3f209e1 100644
--- a/package.json
+++ b/package.json
@@ -4,7 +4,9 @@
   "description": "",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "tsc",
+    "start": "node src/index.js"
   },
   "author": "",
   "license": "ISC",