diff --git a/README.md b/README.md index 2d9730a..03db6a1 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,11 @@ # talk-codebase + [![Node.js Package](https://github.com/rsaryev/talk-codebase/actions/workflows/python-publish.yml/badge.svg)](https://github.com/rsaryev/talk-codebase/actions/workflows/python-publish.yml) -Talk-codebase is a tool that allows you to converse with your codebase using Large Language Models (LLMs) to answer your queries. It supports offline code processing using LlamaCpp and [GPT4All](https://github.com/nomic-ai/gpt4all) without sharing your code with third parties, or you can use OpenAI if privacy is not a concern for you. Please note that talk-codebase is still under development and is recommended for educational purposes, not for production use. +Talk-codebase is a tool that allows you to converse with your codebase using Large Language Models (LLMs) to answer your +queries. It supports offline code processing using LlamaCpp and [GPT4All](https://github.com/nomic-ai/gpt4all) without +sharing your code with third parties, or you can use OpenAI if privacy is not a concern for you. Please note that +talk-codebase is still under development and is recommended for educational purposes, not for production use.
@@ -9,6 +13,8 @@ Talk-codebase is a tool that allows you to converse with your codebase using Lar
## Installation
+Requirement Python 3.8.1 or higher
+
```bash
pip install talk-codebase
```
@@ -25,7 +31,8 @@ Select model type: Local or OpenAI
OpenAI
-If you use the OpenAI model, you need an OpenAI API key. You can get it from [here](https://beta.openai.com/). Then you will be offered a choice of available models.
+If you use the OpenAI model, you need an OpenAI API key. You can get it from [here](https://beta.openai.com/). Then you
+will be offered a choice of available models.
@@ -46,7 +53,8 @@ talk-codebase configure
## Advanced configuration
-You can manually edit the configuration by editing the `~/.config.yaml` file. If you cannot find the configuration file, run the tool and it will output the path to the configuration file at the very beginning.
+You can manually edit the configuration by editing the `~/.config.yaml` file. If you cannot find the configuration file,
+run the tool and it will output the path to the configuration file at the very beginning.
## Supported Extensions
@@ -61,6 +69,11 @@ You can manually edit the configuration by editing the `~/.config.yaml` file. If
## Contributing
-* If you find a bug in talk-codebase, please report it on the project's issue tracker. When reporting a bug, please include as much information as possible, such as the steps to reproduce the bug, the expected behavior, and the actual behavior.
-* If you have an idea for a new feature for Talk-codebase, please open an issue on the project's issue tracker. When suggesting a feature, please include a brief description of the feature, as well as any rationale for why the feature would be useful.
-* You can contribute to talk-codebase by writing code. The project is always looking for help with improving the codebase, adding new features, and fixing bugs.
+* If you find a bug in talk-codebase, please report it on the project's issue tracker. When reporting a bug, please
+ include as much information as possible, such as the steps to reproduce the bug, the expected behavior, and the actual
+ behavior.
+* If you have an idea for a new feature for Talk-codebase, please open an issue on the project's issue tracker. When
+ suggesting a feature, please include a brief description of the feature, as well as any rationale for why the feature
+ would be useful.
+* You can contribute to talk-codebase by writing code. The project is always looking for help with improving the
+ codebase, adding new features, and fixing bugs.
diff --git a/pyproject.toml b/pyproject.toml
index 25c1f84..9828a0b 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,6 +1,6 @@
[tool.poetry]
name = "talk-codebase"
-version = "0.1.45"
+version = "0.1.46"
description = "talk-codebase is a powerful tool for querying and analyzing codebases."
authors = ["Saryev Rustam