Updated README

Author: hrshdhgd

README.md

@@ -1,7 +1,97 @@
-# llm-change-agent
+# LLM Change Agent
 
-Ontobot change agent assistant that uses LLMs to generate change language.commands.
+## Overview
+LLM Change Agent is a command-line tool designed to interact with various language models from different providers. It allows users to generate text using specified models and providers.
 
+## Features
+- Given a prompt relevant to making ontology resource changes, the agent responds with KGCL change statements.
+- Supports OpenAI, Ollama, Anthropic and CBORG (LBNL hosted) models.
+
+## **:warning:** OpenAI, Anthropic and CBORG model use are subject to availability of corresponding keys as environment variables.
+
+## Installation
+To install the dependencies, run:
+```bash
+pip install llm-change-agent
+```
+
+## Usage
+The CLI provides several commands to interact with the language models.
+
+### List Available Models
+To list all available models from supported providers:
+```bash
+lca list-models
+
+OpenAI models:
+  gpt-4o-2024-08-06
+  gpt-4o-mini
+  gpt-4o-mini-2024-07-18
+  gpt-4o-2024-05-13
+  gpt-4o
+  gpt-4-turbo-2024-04-09
+  gpt-4-turbo
+  gpt-4-turbo-preview
+Anthropic models:
+  claude-3-5-sonnet-20240620
+  claude-3-opus-20240229
+  claude-3-sonnet-20240229
+  claude-3-haiku-20240307
+Ollama models:
+  llama3.1
+LBL-CBORG models:
+  lbl/llama-3
+  openai/gpt-4o-mini
+  anthropic/claude-haiku
+  anthropic/claude-sonnet
+  anthropic/claude-opus
+```
+
+### Generate Text
+To generate text using a specified model and provider:
+```bash
+lca execute --model <MODEL_NAME> --provider <PROVIDER_NAME> --prompt "<YOUR_PROMPT>"
+```
+Replace `<MODEL_NAME>`, `<PROVIDER_NAME>`, and `<YOUR_PROMPT>` with your desired values.
+
+### Examples
+- Generate text using CBORG's `lbl/llama-3` model with a custom prompt:
+```bash
+lca execute --model lbl/llama-3 --prompt "I want to change the definition of class ABC:123 to 'foo bar' and also create a new class labelled 'bar foo' with the curie DEF:123."
+```
+OR
+```bash
+lca execute --provider cborg --prompt "I want to change the definition of class ABC:123 to 'foo bar' and also create a new class labelled 'bar foo' with the curie DEF:123."
+```
+
+generates
+
+```bash
+Final Answer: 
+
+[
+  "change definition of ABC:123 to 'foo bar'",
+  "create class DEF:123 'bar foo'"
+]
+
+```
+
+## Development
+To run the project locally, clone the repository and navigate to the project directory:
+```bash
+git clone https://github.com/yourusername/llm-change-agent.git
+cd llm-change-agent
+poetry install
+```
+Make sure you have `poetry` installed in your system.
+
+## Contributing
+Contributions are welcome! Please submit a pull request or open an issue to discuss any changes.
+
+## License
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+---
 # Acknowledgements
 
 This [cookiecutter](https://cookiecutter.readthedocs.io/en/stable/README.html) project was developed from the [monarch-project-template](https://github.com/monarch-initiative/monarch-project-template) template and will be kept up-to-date using [cruft](https://cruft.github.io/cruft/).