Skip to content

Commit e838a36

Browse files
committed
release: v0.2.19 (Docs Updated)
1 parent 7df6956 commit e838a36

2 files changed

Lines changed: 35 additions & 68 deletions

File tree

README.md

Lines changed: 34 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Conduit Console
22

3-
![Version](https://img.shields.io/badge/version-v0.2.18-blue?style=flat-square)
3+
![Version](https://img.shields.io/badge/version-v0.2.19-blue?style=flat-square)
44
![Branch](https://img.shields.io/badge/branch-main-purple?style=flat-square)
5+
![Platform](https://img.shields.io/badge/platform-Linux-green?style=flat-square)
56
![License](https://img.shields.io/badge/license-MIT-orange?style=flat-square)
6-
![Author](https://img.shields.io/badge/author-Babak%20Sorkhpour-blueviolet?style=flat-square)
77

8-
> **Professional Management Console** > A high-performance, bash-based tool to manage, monitor, and optimize Native (Systemd) and Docker instances.
9-
> *Developed & Maintained by [Babak Sorkhpour](https://github.com/babakskr)*
8+
> **Professional Management Console** > A unified console to manage Native (Systemd) and Docker instances.
9+
> *Developed by Babak Sorkhpour*
1010
1111
---
1212

@@ -15,85 +15,52 @@
1515
- [Installation](#-installation)
1616
- [Tools Reference](#-tools-reference)
1717
- [Configuration](#-configuration)
18-
- [Development Guidelines](#-development-guidelines)
18+
- [Release Management](#-release-management)
1919

2020
---
2121

22-
## 🚀 Installation
22+
## 📂 Project Structure (Manifest)
2323

24-
### Prerequisites
25-
* **OS:** Linux (Ubuntu/Debian)
26-
* **User:** Root privileges required.
27-
* **Dependencies:** `curl`, `git`, `docker` (optional).
24+
### 🔹 Core Components
25+
| File | Ver | Description |
26+
| :--- | :--- | :--- |
27+
| `conduit-console.sh` | v0.2.19 | No description provided. |
28+
| `conduit-optimizer.sh` | v1.8.2 | Adjusts CPU (Nice) and I/O priorities for Conduit instances to prevent lag. |
2829

29-
### Quick Start
30-
```bash
31-
# 1. Clone the repository
32-
git clone https://github.com/babakskr/Conduit-console
33-
cd Conduit-console
30+
### 🔹 Utilities & Automation
31+
| File | Ver | Description |
32+
| :--- | :--- | :--- |
33+
| `git_op.sh` | v2.4.0 | Automates version control, README generation, deletions, and GitHub releases. |
3434

35-
# 2. Set permissions
36-
chmod +x *.sh
37-
38-
# 3. Run the Main Console
39-
sudo ./conduit-console.sh
40-
```
35+
### 🔹 Documentation & Config
36+
| File | Description |
37+
| :--- | :--- |
38+
| `AI_DEV_GUIDELINES.md` | - |
39+
| `docs/AI_HANDOFF.md` | No description provided. |
40+
| `docs/KNOWN_RISKS.md` | No description provided. |
41+
| `.github/workflows/ci-bash.yml` | No description provided. |
42+
| `.github/workflows/release.yml` | No description provided. |
4143

4244
---
4345

44-
## 🛠 Tools Reference
46+
## 🚀 Installation
4547

46-
### 1. Main Console (`conduit-console.sh`)
47-
**Description:** The central hub for monitoring traffic, managing services, and viewing logs.
48-
**Usage:**
48+
### Quick Setup
4949
```bash
50+
git clone https://github.com/babakskr/Conduit-console
51+
cd Conduit-console
52+
chmod +x *.sh
5053
sudo ./conduit-console.sh
5154
```
52-
**Key Features:**
53-
* Real-time Traffic Dashboard (HTOP style).
54-
* Auto-detection of Systemd services and Docker containers.
55-
* Zero-dependency architecture.
56-
57-
### 2. Performance Optimizer (`conduit-optimizer.sh`)
58-
**Description:** Adjusts CPU/IO priorities to prevent system lag under load.
59-
**Usage:**
60-
```bash
61-
# Automatic Mode (Recommended)
62-
sudo ./conduit-optimizer.sh
63-
64-
# Manual Mode (Custom Priorities)
65-
sudo ./conduit-optimizer.sh -dock 5 -srv 10
66-
```
67-
68-
### 3. Release Manager (`git_op.sh`)
69-
**Description:** Automates versioning, documentation generation, and GitHub releases.
70-
**Usage:**
71-
```bash
72-
./git_op.sh # Create a full release
73-
./git_op.sh -l # Check project status
74-
```
7555

7656
---
7757

78-
## ⚙️ Configuration
79-
80-
The project uses a central configuration file `project.conf`.
81-
You can customize the project name, repository URL, and defaults by editing this file.
82-
83-
```bash
84-
nano project.conf
85-
```
86-
87-
---
88-
89-
## 📚 Development Guidelines
90-
91-
We follow strict strict coding standards to ensure stability and security.
92-
Please refer to the following documents before contributing:
58+
## 🔄 Release Management
9359

94-
* **[AI_DEV_GUIDELINES.md](AI_DEV_GUIDELINES.md):** The "Constitution" for AI assistants and developers.
95-
* **[KNOWN_RISKS.md](KNOWN_RISKS.md):** Registry of known bugs and required guards.
96-
* **[AI_HANDOFF.md](AI_HANDOFF.md):** Operational log for development continuity.
60+
| Command | Action |
61+
| :--- | :--- |
62+
| `./git_op.sh main` | **Full Release:** Merge to main, Update README, Tag, Push. |
63+
| `./git_op.sh -d <file>` | **Delete:** Remove file locally and remotely. |
9764

9865
---
99-
*Last Updated: Thu Jan 29 09:44:30 PM UTC 2026* *© 2026 Babak Sorkhpour. All Rights Reserved.*
66+
*Generated by Git Operations Manager v2.4.0 on Thu Jan 29 09:55:50 PM UTC 2026*

conduit-console.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
# Copyright (C) 2026 Babak Sorkhpour
88
# Written by Dr. Babak Sorkhpour with help of ChatGPT
99
#
10-
# Version: 0.2.18
10+
# Version: 0.2.19
1111
#
1212
# Key rules:
1313
# - Interactive TUI: DO NOT use `set -e`

0 commit comments

Comments
 (0)