From 076e39966f50ac6efc8013c4aa92839e3f1400e8 Mon Sep 17 00:00:00 2001
From: peterdanwan <peterdanwan@gmail.com>
Date: Sun, 8 Sep 2024 17:24:26 -0400
Subject: [PATCH] Added a Getting Started section to the README.md

---
 README.md    | 40 +++++++++++++++++++++-------------------
 package.json |  5 +++--
 2 files changed, 24 insertions(+), 21 deletions(-)

diff --git a/README.md b/README.md
index 31a4c25..cb973ee 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
 ## Table of Contents
 
 1. [What is gimme_readme?][1-what-is-gimme-readme]
-2. [Dependencies][2-dependencies]
+2. [Getting Started][2-getting-started]
 3. [Example Usage][3-example-usage]
 4. [Contributing][4-contributing]
 
@@ -11,39 +11,41 @@
 
 `gimme_readme` is a command-line tool that uses `OpenAI` to generate a `README.md` file that explains a given source code file.
 
-## 2. Dependencies
+## 2. Getting Started
 
-To use the `gimme_readme`, you must do the following:
+To use the `gimme_readme`, you must:
 
-1. Install the latest version of [Python `3`, which comes with the `PIP` package manager](https://www.python.org/downloads/) (this will _not_ work with earlier versions of `Python`).
-2. Install [openai] via the following command:
-
-   ```sh
-   pip install openai
-   ```
-
-   - NOTE: If you are on `Windows`, you must run this command as an `Administrator`.
-
-3. Have a copy of `gr.py`, the main source file which will handle creating a `README.md` file based on your source code.
+1. Install the latest version of [node](https://nodejs.org/en/download/package-manager) for your `operating system`.
+2. Run `npm i -g gimme_readme`, which installs `gimme_readme` globally.
 
 ## 3. Example Usage
 
-### On Linux / Mac OS
+### Display all details
 
 ```sh
-./gr.py FILE
+gr
 ```
 
-### On Windows
+### Display version number
 
 ```sh
-py ./gr.py FILE
+# Can do this
+gr -v
+# Or this
+gr --version
 ```
 
 ## 4. Contributing
 
-Contributions to this project is welcomed! Please look for any [issues](https://github.com/peterdanwan/gimme_readme/issues)
+Contributions to this project are welcomed!
+
+We ask that you first check to see if the issue you've encountered or feature you wish to add is under the existing list of [issues](https://github.com/peterdanwan/gimme_readme/issues).
+
+If your issue or suggested feature is already, please add onto the existing issue by adding your comments or making `pull request` with what you believe to be a valid change to the code.
+
+Otherwise, if your issue or suggestion is not already list, please feel free to create a new issue, and if possible create a `pull request` that you think will resolve your issue.
 
 [1-what-is-gimme-readme]: #1-what-is-gimme_readme
-[2-dependencies]: #2-dependencies
+[2-getting-started]: #2-getting-started
 [3-example-usage]: #3-example-usage
+[4-contributing]: #4-contributing
diff --git a/package.json b/package.json
index 9dab483..abeb138 100644
--- a/package.json
+++ b/package.json
@@ -4,7 +4,7 @@
   "description": "A CLI tool that generates a markdown file that explains your code using AI",
   "author": "Peter Wan",
   "license": "MIT",
-  "main": "gr.js",
+  "main": "_gr.js",
   "bin": {
     "gr": "./src/_gr.js"
   },
@@ -21,7 +21,8 @@
     "ai",
     "chat-completion",
     "learning",
-    "README.md"
+    "README.md",
+    "aryan"
   ],
   "bugs": {
     "url": "https://github.com/peterdanwan/gimme_readme/issues"