Merge branch 'main' of github.com:Giton-App/giton-cli

README.md

@@ -1,15 +1,35 @@
+giton
+------------
+[![Build](https://github.com/Giton-App/giton-cli/actions/workflows/build.yml/badge.svg)](https://github.com/Giton-App/giton-cli/actions/workflows/build.yml)
+[![Crates.io](https://img.shields.io/crates/v/giton.svg)](https://crates.io/crates/giton)
+[![MIT License](https://img.shields.io/github/license/Giton-App/giton-cli)](https://github.com/Giton-App/giton-cli/LICENSE)
+
+`giton` is an AI augmentation program for `git`. It uses Open AI GPT-4, and your local git context to generate commands. `giton` CLI will passthrough `git` commands and only add a few commands for generation.
+
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 **Table of Contents**
 
-- [giton](#giton)
+- [Installation](#installation)
+- [Examples](#examples)
+- [GPT-4 Costs](#gpt-4-costs)
+- [Vulnerability reporting](#vulnerability-reporting)
+- [License](#license)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
-<h1 align="center">giton</h1>
-<div align="center">
- <strong>
-    An AI-powered tool for Git.
- </strong>
-</div>
-<br/>
+### Installation
+
+### Examples
+
+### GPT-4 Costs
+
+### Vulnerability reporting
+
+For reporting a security vulnerability, you can directly [send me an email](mailto:giton@omarabid.com).
+
+### License
+
+giton is distributed under the MIT License.
+
+See [LICENSE](LICENSE) for details.