WIP

Author: habedi

README.md

@@ -1,14 +1,10 @@
-## TypeScript Project Template
-
 <div align="center">
   <picture>
-    <img alt="Project Logo" src="logo.svg" height="25%" width="25%">
+    <img alt="Tobi Logo" src="logo.svg" height="20%" width="20%">
   </picture>
-</div>
-
 <br>
 
-<div align="center">
+<h2>Tobi</h2>
 
 [![Tests](https://img.shields.io/github/actions/workflow/status/habedi/template-typescript-project/tests.yml?label=tests&style=flat&labelColor=333333&logo=github&logoColor=white)](https://github.com/habedi/template-typescript-project/actions/workflows/tests.yml)
 [![Code Coverage](https://img.shields.io/codecov/c/github/habedi/template-typescript-project?style=flat&label=coverage&labelColor=333333&logo=codecov&logoColor=white)](https://codecov.io/gh/habedi/template-typescript-project)
@@ -19,35 +15,29 @@
 [![Managed with npm](https://img.shields.io/badge/managed%20with-npm-CB3837?style=flat&logo=npm&labelColor=333333&logoColor=white)](https://www.npmjs.com/)
 [![Makefile](https://img.shields.io/badge/managed%20with-Makefile-000000?style=flat&logo=gnu&labelColor=333333&logoColor=white)](https://www.gnu.org/software/make/)
 
+An AI coding assistant that always ready to help you
+
 </div>
 
 ---
 
-This is a template repository for creating new TypeScript projects.
-It includes a basic structure, a `Makefile` for common developmental tasks, and a set of GitHub Actions workflows for
-running the tests.
-I am sharing this template in case others find it useful.
+Tobi is an AI coding assistant.
 
 ### Features
 
-- **TypeScript**: a basic setup for a TypeScript project.
-- **Makefile**: for managing common tasks like testing, linting, and formatting.
-- **GitHub Actions**: for running tests, linting, and publishing packages.
-- **Badges**: for showing the status of tests, code quality, version, etc.
-- **Default files**: for configuration, testing, and documentation, like `.gitignore`, `README.md`, `LICENSE`, etc.
+- Able to use models provided by OpenAI, Google, Anthropic, and Ollama.
+- Fully customizable.
+- Fast and secure.
+- Can be used as a CLI with a rich TUI.
+- Has a built-in retrieval-augmented generation pipeline.
+- Has the ability to use tools (call functions) including connecting to model context protocol (MCP) server.
 
-### Prerequisites
 
-- `Node.js >=20.0.0`
-- `npm` for package management
-- `GNU Make`
+---
 
-### Usage
+### Getting Started
 
-1. Use the `Use this template` button on GitHub to create a new repository based on this template.
-2. Modify the `README.md` file and other files as needed.
-3. Run `make install` to install the project dependencies.
-4. Run `make help` to see all available commands for managing different tasks.
+To be added.
 
 ---
 
@@ -57,9 +47,8 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to make a contribution
 
 ### License
 
-This template is licensed under the MIT License ([LICENSE](LICENSE) or https://opensource.org/licenses/MIT)
+This template is licensed under the MIT License (see [LICENSE](LICENSE)).
 
 ### Acknowledgements
 
 - The logo is from [SVG Repo](https://www.svgrepo.com/svg/388730/terminal).
-- The logo with two colors is from [SVG Repo](https://www.svgrepo.com/svg/372115/terminal-badged).