docs: added README files for the examples

evilsocket · Jun 24, 2024 · b64a1b6 · b64a1b6
1 parent 277eca4
commit b64a1b6
Show file tree

Hide file tree

Showing 10 changed files with 10 additions and 0 deletions.
diff --git a/examples/README.md b/examples/README.md
@@ -0,0 +1 @@
+Example Nerve tasklets, check the individual READMEs for specific information.
diff --git a/examples/ai_news/README.md b/examples/ai_news/README.md
@@ -0,0 +1 @@
+Fetches the latest AI news and provides a few bullet-points summary.
diff --git a/examples/code_auditor/README.md b/examples/code_auditor/README.md
@@ -0,0 +1 @@
+Looks for vulnerabilities in the specified code folder.
diff --git a/examples/fs_explorer/README.md b/examples/fs_explorer/README.md
@@ -0,0 +1 @@
+Performs a simple task by accessing the filesystem.
diff --git a/examples/fuzzer/README.md b/examples/fuzzer/README.md
@@ -0,0 +1 @@
+Fuzzes a test binary in order to find a crash.
diff --git a/examples/kali_pentester/README.md b/examples/kali_pentester/README.md
@@ -0,0 +1 @@
+Uses access to a Kali computer (default nerve@kali.local, can be set via KALI_VM_CONNECTION_STRING).
diff --git a/examples/models/README.md b/examples/models/README.md
@@ -0,0 +1 @@
+Example model files for ollama.
diff --git a/examples/ssh_agent/README.md b/examples/ssh_agent/README.md
@@ -0,0 +1 @@
+Executes tasks on a remote computer by executing bash commands on it via ssh.
diff --git a/examples/web_vulnerability_scanner/README.md b/examples/web_vulnerability_scanner/README.md
@@ -0,0 +1 @@
+Performs simple HTTP requests to find vulnerabilities in a target website.
diff --git a/examples/weird_chat/README.md b/examples/weird_chat/README.md
@@ -0,0 +1 @@
+Uses one LLM to simulate a two people chat between Bob and Alice.