tempering-ai 0.1.2

package/README.md

@@ -0,0 +1,64 @@
+# tempering-ai
+
+`tempering-ai` is a command-line interface (CLI) application designed to serve as an interactive AI companion. Built with TypeScript and Bun, it leverages advanced AI models to provide conversational capabilities and assist users through interactive prompts directly in their terminal.
+
+## Features
+
+*   **Interactive AI Conversations**: Engage with an AI model directly from your command line.
+*   **Cross-Platform**: Binaries available for Linux, macOS, and Windows in the [GitHub Releases](https://github.com/osinnanna/tempering-ai/releases).
+*   **Easy Installation**: Installable as a global NPM package.
+*   **Fast and Efficient**: Built with Bun for a speedy development and runtime experience.
+
+## Installation
+
+There are two ways to install `tempering-ai`:
+
+### 1. Using NPM (Recommended)
+
+You can install `tempering-ai` globally using NPM:
+
+```bash
+npm install -g tempering-ai
+```
+
+This will make the `tempering-ai` command available in your terminal.
+
+### 2. From Binaries
+
+Alternatively, you can download the appropriate binary for your operating system (Linux, macOS, or Windows) from the [GitHub Releases](https://github.com/osinnanna/tempering-ai/releases) page.
+
+## Usage
+
+After installation, you can run the `tempering-ai` application by simply typing:
+
+```bash
+tempering-ai
+```
+
+Follow the on-screen prompts to interact with your AI companion.
+
+## Development
+
+For developers interested in contributing or modifying `tempering-ai`:
+
+1.  **Clone the repository:**
+    ```bash
+    git clone https://github.com/osinnanna/tempering-ai.git
+    cd tempering-ai
+    ```
+2.  **Install dependencies using Bun:**
+    ```bash
+    bun install
+    ```
+3.  **Build the application:**
+    ```bash
+    bun run build
+    ```
+4.  **Run the application:**
+    ```bash
+    ./dist/tempering-ai
+    ```
+
+## License
+
+This project is licensed under the MIT License.