diff --git a/README.md b/README.md index 7b32371..3e445d9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,29 @@ # askai -This is a program called askai. It takes in data from the user through stdin and arguments. It then uses it to generate responses. For example, if you input some log files and ask it a question about what happened in those log files. \ No newline at end of file +## Overview +askai is an interactive Linux tool that processes data from stdin according to user-specified instructions. It utilizes LangChain's Ollama model for generating responses. + +## Usage +To use the tool, simply input your information through stdin and pass your command line argument as a parameter. If you want to save default settings or update them, run the code with `--config` flag. + + +## Installation +To install this tool first create a venv python enviorment. +```bash +python3 -m venv askai +``` + +Next download the repository and install askai. +```bash +git clone https://gitea.locker98.com/tofasthacker/askai.git +cd askai +pip install -r requirements.txt +sudo cp askai /bin/askai +askai --config +``` + + +## Example Usage +```bash +echo "This is some data" | askai "Discribe the input" --config +```