Skip to content

Commit 8bccadf

Browse files
authored
Update README.md
1 parent fcafd4d commit 8bccadf

1 file changed

Lines changed: 42 additions & 14 deletions

File tree

README.md

Lines changed: 42 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ Built by [Convergence - Human And Technology](https://github.com/Convergence-Hum
1717
The entire logic fits in one Python file with fewer than 90 lines of code.
1818
Every concept, every line, every choice is explained.
1919

20-
---
20+
<p align="center">
21+
<img src="https://github.com/madjeek-web/about/raw/main/hr.png" alt="separator" width="300" height="3">
22+
</p>
2123

2224
## Table of Contents
2325

@@ -34,7 +36,9 @@ Every concept, every line, every choice is explained.
3436
11. [License](#11-license)
3537
12. [Contact](#12-contact)
3638

37-
---
39+
<p align="center">
40+
<img src="https://github.com/madjeek-web/about/raw/main/hr.png" alt="separator" width="300" height="3">
41+
</p>
3842

3943
## 1. What is this project ?
4044

@@ -51,7 +55,9 @@ This project is for you if :
5155

5256
There is no magic here. Just Python, one API call per step, and clear comments.
5357

54-
---
58+
<p align="center">
59+
<img src="https://github.com/madjeek-web/about/raw/main/hr.png" alt="separator" width="300" height="3">
60+
</p>
5561

5662
## 2. What is an Executive AI ?
5763

@@ -76,7 +82,9 @@ In code, this breaks down into three phases :
7682

7783
The key insight is that we use the same AI model for both phases. What changes is the system prompt we give it. The AI does not "know" it is an agent. We create that behavior through prompt design.
7884

79-
---
85+
<p align="center">
86+
<img src="https://github.com/madjeek-web/about/raw/main/hr.png" alt="separator" width="300" height="3">
87+
</p>
8088

8189
## 3. Core Concepts
8290

@@ -98,7 +106,9 @@ AI models do not process words, they process tokens. A token is roughly three qu
98106

99107
An environment variable is a value stored in your operating system, outside of your code. We use one called `ANTHROPIC_API_KEY` to store the API key. This is the standard practice for secrets. If you write the key directly in your Python file and push it to GitHub, it becomes public. Environment variables prevent that.
100108

101-
---
109+
<p align="center">
110+
<img src="https://github.com/madjeek-web/about/raw/main/hr.png" alt="separator" width="300" height="3">
111+
</p>
102112

103113
## 4. Project Structure
104114

@@ -133,7 +143,9 @@ executive-ai-core/
133143

134144
Where to start : open `src/main/executive_ai.py`. That file is the entire project. Everything else supports it.
135145

136-
---
146+
<p align="center">
147+
<img src="https://github.com/madjeek-web/about/raw/main/hr.png" alt="separator" width="300" height="3">
148+
</p>
137149

138150
## 5. Prerequisites
139151

@@ -147,7 +159,9 @@ No other tools, frameworks, or services are required.
147159

148160
The free tier of the Anthropic API is enough to run this project. A typical execution (5 steps) costs a fraction of a cent.
149161

150-
---
162+
<p align="center">
163+
<img src="https://github.com/madjeek-web/about/raw/main/hr.png" alt="separator" width="300" height="3">
164+
</p>
151165

152166
## 6. Installation
153167

@@ -195,7 +209,9 @@ Or run the setup script, which handles everything :
195209
bash scripts/setup.sh
196210
```
197211

198-
---
212+
<p align="center">
213+
<img src="https://github.com/madjeek-web/about/raw/main/hr.png" alt="separator" width="300" height="3">
214+
</p>
199215

200216
## 7. Usage
201217

@@ -240,7 +256,9 @@ Phase 2 - Execution
240256
Done. 5 step(s) completed.
241257
```
242258

243-
---
259+
<p align="center">
260+
<img src="https://github.com/madjeek-web/about/raw/main/hr.png" alt="separator" width="300" height="3">
261+
</p>
244262

245263
## 8. How It Works
246264

@@ -280,7 +298,9 @@ Notice that the whole system makes N+1 API calls where N is the number of steps
280298

281299
More advanced agents add memory (storing past actions), tool use (calling external APIs), and error recovery (retrying failed steps). Those are the next things to explore once you understand this baseline.
282300

283-
---
301+
<p align="center">
302+
<img src="https://github.com/madjeek-web/about/raw/main/hr.png" alt="separator" width="300" height="3">
303+
</p>
284304

285305
## 9. Running Tests
286306

@@ -311,7 +331,9 @@ Ran 4 tests in 0.003s
311331
OK
312332
```
313333

314-
---
334+
<p align="center">
335+
<img src="https://github.com/madjeek-web/about/raw/main/hr.png" alt="separator" width="300" height="3">
336+
</p>
315337

316338
## 10. Contributing
317339

@@ -325,15 +347,19 @@ Good first issues for beginners :
325347
- Write tests for the `run()` function using mocking
326348
- Add support for a second AI provider (OpenAI, Mistral, or Ollama for local models)
327349

328-
---
350+
<p align="center">
351+
<img src="https://github.com/madjeek-web/about/raw/main/hr.png" alt="separator" width="300" height="3">
352+
</p>
329353

330354
## 11. License
331355

332356
This project is licensed under the MIT License. See [LICENSE](LICENSE) for the full text.
333357

334358
MIT means : you can use, copy, modify, and distribute this code freely, for any purpose, as long as you include the original license notice. You do not need to ask permission.
335359

336-
---
360+
<p align="center">
361+
<img src="https://github.com/madjeek-web/about/raw/main/hr.png" alt="separator" width="300" height="3">
362+
</p>
337363

338364
## 12. Contact
339365

@@ -346,6 +372,8 @@ Project maintained by [Convergence - Human And Technology](https://github.com/Co
346372
- [Facebook : Convergence - Human And Technology](https://www.facebook.com/people/Convergence-Human-And-Technology/61578483081894/)
347373
- [GitHub : Convergence - Human And Technology](https://github.com/Convergence-Human-And-Technology)
348374

349-
---
375+
<p align="center">
376+
<img src="https://github.com/madjeek-web/about/raw/main/hr.png" alt="separator" width="300" height="3">
377+
</p>
350378

351379
Last updated : 27/03/2026

0 commit comments

Comments
 (0)