:pen: put some examples out there

README.md

@@ -61,7 +61,44 @@ On December 25, 2022, in New York City, the sun will rise at 07:16 AM and set at
 
 ## Usage
 
-
+Suggested use is:
+- serve with `vllm`
+- use agent `qwen_agent`
+
+
+### Example Qwen Agent Usage
+
+```python
+agent = Assistant(
+    llm={
+        "model": "WHATEVER420/script-kiddy",
+        "model_server": base_url,
+        "api_key": "EMPTY",
+        "generate_cfg": {
+            "max_tokens": 1000,
+            "temperature": 0.0,
+            "top_p": 0.9,
+            "frequency_penalty": 0.5,
+            "presence_penalty": 0.0,
+            "extra_body": {
+                "chat_template_kwargs": {
+                    "enable_thinking": False,
+                },
+            },
+        },
+    },
+    function_list=["nmap", "gobuster"],
+)
+
+stream = agent.run(
+    [
+        {
+            "role": "user",
+            "content": query,
+        },
+    ],
+)
+```
 
 ### Model Description
 
@@ -95,39 +132,6 @@ This software is provided strictly for educational and research purposes only. I
 
 <!-- This section describes the evaluation protocols and provides the results. -->
 
-### Testing Data, Factors & Metrics
-
-#### Testing Data
-
-<!-- This should link to a Dataset Card if possible. -->
-
-[More Information Needed]
-
-#### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
-[More Information Needed]
-
-#### Metrics
-
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
-[More Information Needed]
-
-### Results
-
-[More Information Needed]
-
-#### Summary
-
-
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
-
-[More Information Needed]
 
 ## Environmental Impact