Skip to content

Commit 1de4412

Browse files
authored
Merge pull request #34 from DevMando/README_Update_Nuget_publish
Update README with NuGet install instructions
2 parents 69e9780 + 0687b41 commit 1de4412

1 file changed

Lines changed: 16 additions & 4 deletions

File tree

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
1+
<p align="center">
2+
<img src="docs/images/MC.png" alt="MandoCode Logo" width="120">
3+
</p>
4+
15
<h1 align="center">MandoCode</h1>
26

37
<p align="center">
4-
<strong>Your AI coding assistant that runs entirely on your machine.</strong><br>
5-
No API keys. No cloud. No tokens. Just you and your code.
8+
<strong>Your AI coding assistant — run locally or in the cloud with Ollama.</strong><br>
9+
No API keys required. Just you and your code.
610
</p>
711

812
<p align="center">
13+
<a href="https://www.nuget.org/packages/MandoCode"><img src="https://img.shields.io/nuget/v/MandoCode?logo=nuget&color=blue" alt="NuGet"></a>
914
<img src="https://img.shields.io/badge/License-MIT-green.svg" alt="License: MIT">
1015
<img src="https://img.shields.io/badge/.NET-8.0-blueviolet?logo=dotnet" alt=".NET 8.0">
1116
<img src="https://img.shields.io/badge/Ollama-Local%20LLM-black?logo=ollama" alt="Ollama">
@@ -17,17 +22,24 @@
1722
<img src="docs/images/hero-demo.gif" alt="MandoCode in action" width="800">
1823
</p>
1924

20-
MandoCode is a fully local AI coding assistant powered by [Semantic Kernel](https://github.com/microsoft/semantic-kernel) and [Ollama](https://ollama.ai). It gives you Claude-Code-style project awareness — reading, writing, searching, and planning across your entire codebase — without ever leaving your terminal or sending data to the cloud.
25+
MandoCode is an AI coding assistant powered by [Semantic Kernel](https://github.com/microsoft/semantic-kernel) and [Ollama](https://ollama.ai). Run locally or connect to Ollama cloud — no API keys required. It gives you Claude-Code-style project awareness — reading, writing, searching, and planning across your entire codebase — without ever leaving your terminal.
2126

2227
It understands **any file type**: C#, JavaScript, TypeScript, Python, CSS, HTML, JSON, config files, and more.
2328

2429
---
2530

26-
## Quick Start
31+
## Install
2732

2833
```bash
2934
# Prerequisites: .NET 8.0 SDK + Ollama installed and running
3035

36+
dotnet tool install -g MandoCode
37+
mandocode
38+
```
39+
40+
### Or build from source
41+
42+
```bash
3143
git clone https://github.com/DevMando/MandoCode.git
3244
cd MandoCode
3345
dotnet build src/MandoCode/MandoCode.csproj

0 commit comments

Comments
 (0)