From 00991b6c44dfa1c9e6652db2cad2a97abaa90496 Mon Sep 17 00:00:00 2001
From: DJ Gillespie <dj@monumetric.com>
Date: Thu, 12 Dec 2024 10:29:32 -0700
Subject: [PATCH] add readme

---
 README.md | 69 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 69 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c56f787
--- /dev/null
+++ b/README.md
@@ -0,0 +1,69 @@
+# Install Chromedriver
+
+A simple CLI utility to install the matching Chromedriver for your currently installed version of Google Chrome. This tool installs the appropriate version of Chromedriver either in your system's `PATH` or inside your virtual environment if one is enabled.
+
+## Running
+
+Running this tool is pretty simple- in your terminal, run this command
+```
+install-chromedriver
+```
+This will install the chromedriver matching your system chrome in either your `PATH` or in the currently active virtual environment.
+
+If you want to install in a specific directory, pass the `--path` parameter pointing to the location you would like the chromedriver.
+```
+install-chromedriver --path /path/to/install/location
+```
+
+## Features
+- Automatically finds the installed version of Google Chrome.
+- Installs the matching version of Chromedriver.
+- Can install Chromedriver globally or in a virtual environment.
+
+## Requirements
+- Google Chrome installed on the system.
+- Poetry installed either on your system or in a virtualenv
+
+## Installation
+
+You can install this utility as a Python package via pip via `pip install install-chromedriver -i https://monupypi.herokuapp.com`, or by downloading the binary for your operating system.
+
+### Build from Source
+
+1. First, install Poetry if you don't have it:
+
+   ```
+   curl -sSL https://install.python-poetry.org | python3 -
+   ```
+
+2. Clone the repository:
+
+   ```
+   git clone https://git.djg.dev/dahjah/install-chromedriver
+   cd install-chromedriver
+   ```
+
+3. Install:
+
+   ```
+   poetry install
+   ```
+
+
+### Packaging
+
+Building packages is simple- just run 
+```
+poetry run build-all
+```
+
+
+To build just python package and wheel, run
+```
+poetry build
+```
+
+To build just the system binary, run 
+```
+poetry run build-executable
+```
\ No newline at end of file