dev-jas commited on
Commit
cc302da
·
1 Parent(s): d397fab

Update README with detailed project information

Browse files

(UPDATE): [docs]: add Hugging Face link and badge to README for project visibility

Removed metadata and added a detailed description of CodeMind, including features, prerequisites, installation steps, usage instructions, troubleshooting, and contribution guidelines.

Files changed (1) hide show
  1. README.md +4 -10
README.md CHANGED
@@ -1,13 +1,4 @@
1
- ---
2
- title: CodeMind
3
- emoji: 🔧
4
- colorFrom: purple
5
- colorTo: indigo
6
- sdk: static
7
- pinned: false
8
- license: apache-2.0
9
- short_description: AI-powered development assistant CLI Tool
10
- ---
11
 
12
  **CodeMind** is a AI-powered development assistant that runs entirely on your local machine for intelligent document analysis and commit message generation. It leverages modern machine learning models for: helping you understand your codebase through semantic search and generates meaningful commit messages using locally hosted language models, ensuring complete privacy and no cloud dependencies.
13
 
@@ -15,6 +6,9 @@ short_description: AI-powered development assistant CLI Tool
15
  - **Smarter Git Workflow**: Automates the creation of meaningful commit messages by analyzing git diffs and using an LLM to summarize changes.
16
  - **AI-Powered Documentation**: Enables you to ask questions about your project, using your own docs/context rather than just generic answers.
17
 
 
 
 
18
  ## Features
19
 
20
  - **Document Embedding** (using [EmbeddingGemma-300m](https://huggingface.co/google/embeddinggemma-300m))
 
1
+ # CodeMind
 
 
 
 
 
 
 
 
 
2
 
3
  **CodeMind** is a AI-powered development assistant that runs entirely on your local machine for intelligent document analysis and commit message generation. It leverages modern machine learning models for: helping you understand your codebase through semantic search and generates meaningful commit messages using locally hosted language models, ensuring complete privacy and no cloud dependencies.
4
 
 
6
  - **Smarter Git Workflow**: Automates the creation of meaningful commit messages by analyzing git diffs and using an LLM to summarize changes.
7
  - **AI-Powered Documentation**: Enables you to ask questions about your project, using your own docs/context rather than just generic answers.
8
 
9
+ **Check it out on Hugging Face Spaces:**
10
+ [![HuggingFace](https://img.shields.io/badge/-HuggingFace-FDEE21?style=for-the-badge&logo=HuggingFace&logoColor=black)](https://huggingface.co/spaces/dev-jas/CodeMind)
11
+
12
  ## Features
13
 
14
  - **Document Embedding** (using [EmbeddingGemma-300m](https://huggingface.co/google/embeddinggemma-300m))