Add files.sh and LICENSE, update README, remove watch.sh

Author: Linus Oleander

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2023 Linus Oleander
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1 +1,47 @@
-Hello World
+# Git AI Library
+
+## Overview
+
+Git AI is a Rust library that integrates with Git, leveraging OpenAI's GPT-4 model to automatically generate commit messages from code changes. 
+
+This crate installs a `prepare-commit-msg` Git hook in your repository. When you commit without a message, Git AI uses ChatGPT to craft a commit message based on the staged files.
+
+## Installation
+
+1. Ensure Rust and Cargo are installed on your system.
+2. Clone the Git AI repository: `git clone [repository-url]`.
+3. Change to the project directory: `cd git-ai`.
+4. Build the project with: `cargo build --release`.
+5. Install the Git AI binary: `cargo install --path .`.
+
+## Usage
+
+- Move to the Git repository where you want the hook installed.
+- Use `git-ai hook install` to set up the Git hook.
+- Set the OpenAI API key with `git-ai config set api-key <api-key>`.
+
+## Configuration
+
+Use `git-ai config set` followed by:
+
+- `api-key <api-key>`: Set the OpenAI API key.
+- `max-tokens <max-tokens>`: Set the maximum characters for `git diff` passed to OpenAI (default is 5000).
+- `timeout <timeout>`: Set the maximum time in seconds to wait for OpenAI's response (default is 30).
+- `language <language>`: Choose the model language (default is `en`).
+
+## Testing
+
+Execute `cargo test` to run the test suite.
+
+## License
+
+This project is under the MIT License. For more details, see the [LICENSE](LICENSE) file.
+
+## Pre-Publish Checklist
+
+- Decide on an appropriate name for the binary.
+- Update the README with installation and testing instructions.
+- Ensure continuous integration (CI) passes.
+  - Look into ways to simplify the CI process.
+- Define and document configuration options.
+- Implement a feature where CTRL-C resets the terminal.

files.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+# List all files not ignored by .gitignore
+files=$(git ls-files)
+
+# Iterate over the files and display their contents
+for file in $files; do
+    echo "Contents of $file:"
+    cat "$file"
+    echo "--------------------------------"
+done