From 1b66dfa3d2baf0d1f0e1c876601174bdba48f1c0 Mon Sep 17 00:00:00 2001
From: Tib3rius <48113936+Tib3rius@users.noreply.github.com>
Date: Sun, 15 Aug 2021 19:01:48 -0400
Subject: [PATCH] Created Plugins (markdown)

---
 Plugins.md | 7 +++++++
 1 file changed, 7 insertions(+)
 create mode 100644 Plugins.md

diff --git a/Plugins.md b/Plugins.md
new file mode 100644
index 0000000..afe5f41
--- /dev/null
+++ b/Plugins.md
@@ -0,0 +1,7 @@
+# Plugins
+
+AutoRecon uses a plugin system to perform all port and service scanning. By default, plugins are located in the "plugins" directory. All plugins must be contained within files that have a .py extension. If a plugin file starts with an underscore, it will not get loaded by AutoRecon, making it easy to disable certain plugin files.
+
+Each plugin file can contain multiple plugins, and the plugin set which comes with AutoRecon groups plugins into files based on the service they run against (e.g. all the HTTP plugins are in plugins/http.py).
+
+There are two types of plugin that AutoRecon supports: PortScan and ServiceScan. PortScan plugins are provided a Target object which represents a target being scanned by AutoRecon (e.g. 127.0.0.1). They are expected to perform a port / service identification scan and return a list of Service objects which represents the services running on the target. ServiceScan plugins are provided with a Service object and are expected to perform further service enumeration scans.
\ No newline at end of file