Added Documentation explanations on readme file

README.md

@@ -372,7 +372,7 @@ Recommended     Plugin.Import_ocr_enabled       true   Enable or disable the ocr
 In this same menu set any other plugin settings that are required for testing.
 
 ## Install misp-module on an offline instance.
-First, you need to grab all necessery packages for example like this : 
+First, you need to grab all necessery packages for example like this :
 
 Use pip wheel to create an archive
 ~~~
@@ -380,7 +380,7 @@ mkdir misp-modules-offline
 pip3 wheel -r REQUIREMENTS shodan --wheel-dir=./misp-modules-offline
 tar -cjvf misp-module-bundeled.tar.bz2 ./misp-modules-offline/*
 ~~~
-On offline machine : 
+On offline machine :
 ~~~
 mkdir misp-modules-bundle
 tar xvf misp-module-bundeled.tar.bz2 -C misp-modules-bundle
@@ -439,3 +439,14 @@ cd tests/
 curl -s http://127.0.0.1:6666/query -H "Content-Type: application/json" --data @MY_TEST_FILE.json -X POST
 cd ../
 ~~~
+
+## Documentation
+
+In order to provide documentation about some modules that require specific input / output / configuration, the [doc](doc) directory contains detailed information about the general purpose, requirements, features, input and ouput of each of these modules:
+
+- ***description** - quick description of the general purpose of the module, as the one given by the moduleinfo
+- **requirements** - special libraries needed to make the module work
+- **features** - description of the way to use the module, with the required MISP features to make the module give the intended result
+- **references** - link(s) giving additional information about the format concerned in the module
+- **input** - description of the format of data used in input
+- **output** - description of the format given as the result of the module execution

doc/export_mod/cef_export.json

@@ -0,0 +1,3 @@
+{
+    "description": "Module to export a MISP event in CEF format."
+}

doc/export_mod/liteexport.json

@@ -0,0 +1,3 @@
+{
+    "description": "Lite export of a MISP event."
+}

doc/export_mod/pdfexport.json

@@ -0,0 +1,3 @@
+{
+    "description": "Simple export of a MISP event to PDF."
+}

doc/export_mod/testexport.json

@@ -0,0 +1,3 @@
+{
+    "description": "Skeleton export module."
+}

doc/export_mod/threatStream_misp_export.json

@@ -0,0 +1,3 @@
+{
+    "description": "Module to export a structured CSV file for uploading to threatStream."
+}

doc/export_mod/threat_connect_export.json

@@ -0,0 +1,3 @@
+{
+    "description": "Module to export a structured CSV file for uploading to ThreatConnect."
+}

doc/import_doc/cuckooimport.json

@@ -0,0 +1,3 @@
+{
+    "description": "Module to import Cuckoo JSON."
+}

doc/import_doc/email_import.json

@@ -0,0 +1,3 @@
+{
+    "description": "Module to import emails in MISP."
+}

doc/import_doc/mispjson.json

@@ -0,0 +1,3 @@
+{
+    "description": "Module to import MISP JSON format for merging MISP events."
+}

doc/import_doc/ocr.json

@@ -0,0 +1,3 @@
+{
+    "description": "Optical Character Recognition (OCR) module for MISP."
+}

doc/import_doc/openiocimport.json

@@ -0,0 +1,3 @@
+{
+    "description": "Module to import OpenIOC packages."
+}

doc/import_doc/stiximport.json

@@ -0,0 +1,3 @@
+{
+    "description": "Module to import some stix stuff."
+}

doc/import_doc/threatanalyzer_import.json

@@ -0,0 +1,3 @@
+{
+    "description": "Module to import ThreatAnalyzer archive.zip / analysis.json files."
+}

doc/import_doc/vmray_import.json

@@ -0,0 +1,3 @@
+{
+    "description": "Module to import VMRay (VTI) results."
+}