Added Documentation explanations on readme file

pull/233/head
chrisr3d 2018-03-06 16:17:22 +01:00
parent ba2a5f7515
commit 013e552f90
No known key found for this signature in database
GPG Key ID: 6BBED1B63A6D639F
15 changed files with 55 additions and 2 deletions

View File

@ -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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

3
doc/import_doc/ocr.json Normal file
View File

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

View File

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

View File

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

View File

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

View File

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