1- ## TypeScript Project Template
2-
31<div align =" center " >
42 <picture >
5- <img alt="Project Logo" src="logo.svg" height="25 %" width="25 %">
3+ <img alt="Tobi Logo" src="logo.svg" height="20 %" width="20 %">
64 </picture >
7- </ div >
5+ <br >
86
9- <div align = " center " >
7+ <h2 >Tobi</ h2 >
108
11- [ ![ 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 )
12- [ ![ 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 )
13- [ ![ Code Quality] ( https://img.shields.io/codefactor/grade/github/habedi/template-typescript-project?style=flat&label=code%20quality&labelColor=333333&logo=codefactor&logoColor=white )] ( https://www.codefactor.io/repository/github/habedi/template-typescript-project )
14- [ ![ Node.js Version] ( https://img.shields.io/badge/node-%3E=20.0.0-339933?style=flat&labelColor=333333&logo=nodedotjs&logoColor=white )] ( https://nodejs.org/ )
9+ [ ![ Tests] ( https://img.shields.io/github/actions/workflow/status/habedi/tobi/tests.yml?label=tests&style=flat&labelColor=333333&logo=github&logoColor=white )] ( https://github.com/habedi/tobi/actions/workflows/tests.yml )
10+ [ ![ Code Coverage] ( https://img.shields.io/codecov/c/github/habedi/tobi?style=flat&label=coverage&labelColor=333333&logo=codecov&logoColor=white )] ( https://codecov.io/gh/habedi/tobi )
11+ [ ![ Code Quality] ( https://img.shields.io/codefactor/grade/github/habedi/tobi?style=flat&label=code%20quality&labelColor=333333&logo=codefactor&logoColor=white )] ( https://www.codefactor.io/repository/github/habedi/tobi )
1512[ ![ Documentation] ( https://img.shields.io/badge/docs-latest-8ca0d7?style=flat&labelColor=333333&logo=read-the-docs&logoColor=white )] ( docs )
1613[ ![ License] ( https://img.shields.io/badge/license-MIT-00acc1?style=flat&labelColor=333333&logo=open-source-initiative&logoColor=white )] ( LICENSE )
17- [ ![ Managed with npm ] ( https://img.shields.io/badge/managed%20with-npm-CB3837?style=flat&logo=npm&labelColor=333333&logoColor=white )] ( https://www.npmjs.com/ )
18- [ ![ Makefile ] ( https://img.shields.io/badge/managed%20with-Makefile-000000?style=flat&logo=gnu&labelColor=333333&logoColor=white )] ( https://www.gnu.org/software/make/ )
14+
15+ An AI coding assistant that is always ready to help you
1916
2017</div >
2118
2219---
2320
24- This is a template repository for creating new TypeScript projects.
25- It includes a basic structure, a ` Makefile ` for common developmental tasks, and a set of GitHub Actions workflows for
26- running the tests.
27- I am sharing this template in case others find it useful.
21+ Tobi is an AI coding assistant.
2822
2923### Features
3024
31- - ** TypeScript** : a basic setup for a TypeScript project.
32- - ** Makefile** : for managing common tasks like testing, linting, and formatting.
33- - ** GitHub Actions** : for running tests, linting, and publishing packages.
34- - ** Badges** : for showing the status of tests, code quality, version, etc.
35- - ** Default files** : for configuration, testing, and documentation, like ` .gitignore ` , ` README.md ` , ` LICENSE ` , etc.
25+ - Able to use models provided by OpenAI, Google, Anthropic, and Ollama.
26+ - Fully customizable.
27+ - Fast and secure.
28+ - Can be used as a CLI with a rich TUI.
29+ - Has a built-in retrieval-augmented generation pipeline.
30+ - Has the ability to use tools (call functions) including connecting to model context protocol (MCP) server.
3631
37- ### Prerequisites
38-
39- - ` Node.js >=20.0.0 `
40- - ` npm ` for package management
41- - ` GNU Make `
32+ ---
4233
43- ### Usage
34+ ### Getting Started
4435
45- 1 . Use the ` Use this template ` button on GitHub to create a new repository based on this template.
46- 2 . Modify the ` README.md ` file and other files as needed.
47- 3 . Run ` make install ` to install the project dependencies.
48- 4 . Run ` make help ` to see all available commands for managing different tasks.
36+ To be added.
4937
5038---
5139
@@ -55,4 +43,8 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to make a contribution
5543
5644### License
5745
58- This template is licensed under the MIT License ([ LICENSE] ( LICENSE ) or https://opensource.org/licenses/MIT )
46+ This template is licensed under the MIT License (see [ LICENSE] ( LICENSE ) ).
47+
48+ ### Acknowledgements
49+
50+ - The logo is from [ SVG Repo] ( https://www.svgrepo.com/svg/388730/terminal ) .
0 commit comments