chris/styx
chris/styx
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Beautify readme

Browse source
This commit is contained in:
Christopher Talib 2020-02-07 17:50:07 +01:00
parent 2991f830bb
commit 40bfc4b01d
1 changed files with 11 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
README.md
View file

@ -12,12 +12,8 @@ go build
### Meta
`
Node ------ Node
^
|
Edge
`
Node --<Edge>-- Node
```go
type Node struct {
ID string `json:"id"`
@ -41,14 +37,9 @@ type Edge struct {
### Certstream
`
Node ---- CertNode ---- CertStreamRaw
^ | ^
| | |
Edge-> | Edge
|
Node(s) (domain)
`
Node --<Edge>-- CertNode --<Edge>-- CertStreamRaw
Node(domain) --<Edge>-- CertNode
```go
// CertStreamRaw is a wrapper around the stream function to unmarshall the
@ -79,12 +70,8 @@ type CertNode struct {
### Pastebin
`
Node ---- PasteNode ---- FullPaste
^ ^
| |
Edge Edge
`
Node --<Edge>-- PasteNode --<Edge>-- FullPaste
```go
// PasteNode is a node from PasteBin.
type PasteNode struct {
@ -103,12 +90,9 @@ type FullPaste struct {
```
### Shodan
`
Node ---- ShodanNode ---- Node(s) (hostnames and domains)
^ ^
| |
Edge Edge
`
Node --<Edge>-- ShodanNode --<Edge>-- Node(s) (hostnames and domains)
```go
type ShodanNode struct {
ID string `json:"id"`
@ -124,12 +108,7 @@ type ShodanNode struct {
Balboa enrichment happens on domains and hostnames extracted from Certstream
and Shodan streams and the node is created only if Balboa returns data.
`
Node ---- ShodanNode ---- Node (domain) ---- BalboaNode
^ ^ ^
| | |
Edge Edge Edge
`
Node --<Edge>-- ShodanNode --<Edge>-- Node (domain) --<Edge>-- BalboaNode
```go
type BalboaNode struct {