From 207aebe547b37e6d428025362ef2ca1740f88793 Mon Sep 17 00:00:00 2001
From: Alis Akers <alismxwll@gmail.com>
Date: Fri, 31 Jan 2025 17:20:03 -0800
Subject: [PATCH] feat: add package download steps and update dependencies in
 project configuration

---
 README.md      | 11 ++++++++++-
 package.json   | 11 ++++++-----
 pnpm-lock.yaml | 19 +++++++++++++++++++
 3 files changed, 35 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 3024b91..1253d31 100644
--- a/README.md
+++ b/README.md
@@ -11,6 +11,15 @@ Before you begin, ensure that you have the following software installed on your
 
 ## Installation Steps
 
+### Downloading the package
+
+1. Add a package to your project:
+   ```
+   pnpm add github:alismx/gitmsg#0.0.2
+   ```
+
+### Clone the repository
+
 1. Clone the repository:
    ```
    git clone https://github.com/alismx/gitmsg.git
@@ -33,7 +42,7 @@ Before you begin, ensure that you have the following software installed on your
    ```
    This command compiles the TypeScript code into JavaScript.
 
-5. Add `/usr/local/bin/gitmsg` file with contents:
+5. Add `~/bin/gitmsg` file with contents:
     
     ```
     #!/bin/sh
diff --git a/package.json b/package.json
index 67a332a..9d2d69e 100644
--- a/package.json
+++ b/package.json
@@ -4,14 +4,15 @@
   "description": "Use openai to generate commit messages from a diff",
   "main": "index.js",
   "devDependencies": {
-    "prettier": "^2.8.8"
+    "prettier": "^2.8.8",
+    "@alismx/gitmsg": "github:alismx/gitmsg#0.0.2"
   },
   "dependencies": {
-    "openai": "^4.82.0",
-    "minimist": "^1.2.8",
-    "typescript": "^5.7.3",
+    "@types/minimist": "^1.2.5",
     "@types/node": "^18.19.74",
-    "@types/minimist": "^1.2.5"
+    "minimist": "^1.2.8",
+    "openai": "^4.82.0",
+    "typescript": "^5.7.3"
   },
   "scripts": {
     "build": "npx tsc",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 876bc48..3accaf3 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -24,12 +24,19 @@ importers:
         specifier: ^5.7.3
         version: 5.7.3
     devDependencies:
+      '@alismx/gitmsg':
+        specifier: github:alismx/gitmsg#0.0.2
+        version: https://codeload.github.com/alismx/gitmsg/tar.gz/f99bd09c32511173bebdcafb2ad1e130168d4754
       prettier:
         specifier: ^2.8.8
         version: 2.8.8
 
 packages:
 
+  '@alismx/gitmsg@https://codeload.github.com/alismx/gitmsg/tar.gz/f99bd09c32511173bebdcafb2ad1e130168d4754':
+    resolution: {tarball: https://codeload.github.com/alismx/gitmsg/tar.gz/f99bd09c32511173bebdcafb2ad1e130168d4754}
+    version: 0.0.2
+
   '@types/minimist@1.2.5':
     resolution: {integrity: sha512-hov8bUuiLiyFPGyFPE1lwWhmzYbirOXQNNo40+y3zow8aFVTeyn3VWL0VFFfdNddA8S4Vf0Tc062rzyNr7Paag==}
 
@@ -143,6 +150,18 @@ packages:
 
 snapshots:
 
+  '@alismx/gitmsg@https://codeload.github.com/alismx/gitmsg/tar.gz/f99bd09c32511173bebdcafb2ad1e130168d4754':
+    dependencies:
+      '@types/minimist': 1.2.5
+      '@types/node': 18.19.74
+      minimist: 1.2.8
+      openai: 4.82.0
+      typescript: 5.7.3
+    transitivePeerDependencies:
+      - encoding
+      - ws
+      - zod
+
   '@types/minimist@1.2.5': {}
 
   '@types/node-fetch@2.6.12':