README improvements

pull/12/head
Christophe Vandeplas 2018-11-12 13:28:41 +01:00 committed by GitHub
parent 81f2063177
commit f74f5cf398
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 10 deletions

View File

@ -1,6 +1,13 @@
# Quick start guide
This is a Maltego MISP integration tool allowing you to view (read-only) data from a MISP instance.
Currently supported: Event, Attribute, Object, Tag, Taxonomy, Galaxy and relations.
Currently supported MISP elements are : Event, Attribute, Object, Tag, Taxonomy, Galaxy and relations.
Once installed you can start by creating a `MISPEvent` entity, then load the transform `EventToAttributes`.
Alternatively initiate a transform on an existing Maltego entity.
The currently supported entities are: `AS`, `DNSName`, `Domain`, `EmailAddress`, `File`, `Hash`, `IPv4Address`, `NSRecord`, `Person`, `PhoneNumber`, `URL`, `Website`
Dependencies:
* [PyMISP](https://github.com/MISP/PyMISP)
@ -23,14 +30,8 @@ misp_key = verysecretkey
misp_verify = True
misp_debug = False
```
## Usage
Once installed you will have custom Maltego entities in the MISP group.
You can start by creating a `MISPEvent`, then load the transform `EventToAttributes`.
Or by just loading a transform on an existing Maltego entity.
The currently supported entities are: `AS`, `DNSName`, `Domain`, `EmailAddress`, `File`, `Hash`, `IPv4Address`, `NSRecord`, `Person`, `PhoneNumber`, `URL`, `Website`
![Screenshot](https://github.com/MISP/MISP-maltego/doc/screenshot.png)
## Screenshot
![Screenshot](https://github.com/MISP/MISP-maltego/blob/master/doc/screenshot.png)
## License
This software is licensed under [GNU Affero General Public License version 3](http://www.gnu.org/licenses/agpl-3.0.html)
@ -91,4 +92,4 @@ D:This was pointless!
Cool right? If you have any further questions don't hesitate to drop us a line;)
Have fun!
Have fun!