Update README.md

README.md

@@ -2,12 +2,33 @@
 library_name: transformers
 license: apache-2.0
 ---
-### Requirements
+
+# AquilaX-NL-JSON-Start-Scan
+
+## Overview
+AquilaX-NL-JSON-Start-Scan is a model built using Hugging Face's T5-small to convert natural language queries about vulnerabilities into JSON queries for MongoDB. 
+
+## Model Information
+
+### Model
+- **Name**: AquilaX-NL-JSON-Start-Scan
+- **Architecture**: T5-small
+- **Framework**: Hugging Face Transformers
+
+### Description
+The AquilaX-NL-JSON-Start-Scan model is designed to interpret natural language queries related to vulnerabilities in code and convert them into JSON queries that can be executed on a MongoDB database. This facilitates automated scanning and analysis of code repositories for security issues. The model leverages the capabilities of the T5-small architecture, which is well-suited for natural language understanding and generation tasks.
+
+# Getting Started
+
+## Usage
+Below we share some code snippets on how to get quickly started with running the model. First make sure to pip install -U transformers[torch], then copy the snippet from the section.
+
+## Requirements
 ```bash
 pip install transformers[torch]
 ```
 
-### Inference
+## Inference Code
 ```python
 import json
 import requests
@@ -104,4 +125,14 @@ except:
 end = time.time()
 print(to_return)
 print(f"Time taken: {end - start}")
-```
+```
+
+## License
+This project is licensed under the Apache 2.0 License - see the LICENSE file for details.
+
+## Authors
+- [Aquilax-Ai](https://huggingface.co/AquilaX-AI)
+
+## Acknowledgments
+- Hugging Face for the Transformers library.
+- Any other acknowledgments.