Merge pull request #11 from stratosphereips/develop

Develop

.gitignore

@@ -0,0 +1 @@
+*.swp

CONTRIBUTING.md

@@ -2,34 +2,28 @@
 
 All contributions are welcomed, thank you for taking the time to contribute to this project! 
 
-## How can you contribute?
+## What branch should you base your contribution?
 
-* Report bugs
-* Suggest features and ideas
-* Pull requests with a solved GitHub issue and new feature
-* Pull request with a new content.
+As a general rule, base your contribution on the `develop` branch.
 
 ## Persistent Git Branches
 
 The following git branches permanent in the Slips repository:
 
-- `main`: contains the stable version of the repository. All new features should be based on this branch.
+- `main`: contains the stable version of the repository.
+- `develop`: all new features should be based on this branch.
 
 ## Naming Git branches for Pull Requests
 
 To keep the Git history clean and facilitate the revision of contributions we 
 ask all branches to follow concise namings. These are the branch-naming patterns
 to follow when contributing:
 
-- name-bugfix-<>:        pull request branch, contains one bugfix,
-- name-docs-<>:          pull request branch, contains documentation work,
-- name-enhance-<>:       pull request branch, contains one enhancement (not a new feature, but improvement nonetheless)
-- name-feature-<>:       pull request branch, contains a new feature,
-- name-refactor-<>:      pull request branch, contains code refactoring,
-
-## What branch should you base your contribution?
-
-As a general rule, base your contribution on the `main` branch.
+- bugfix-<>:        pull request branch, contains one bugfix,
+- docs-<>:          pull request branch, contains documentation work,
+- enhance-<>:       pull request branch, contains one enhancement (not a new feature, but improvement nonetheless)
+- feature-<>:       pull request branch, contains a new feature,
+- refactor-<>:      pull request branch, contains code refactoring,
 
 ## Creating a pull request
 
@@ -41,3 +35,10 @@ Pull Requests:
 - If you have developed multiple features and/or bugfixes, create separate
     branches for each one of them, and request merges for each branch;
 - The cleaner you code/change/changeset is, the faster it will be merged.
+
+## How can you contribute?
+
+* Report bugs
+* Suggest features and ideas
+* Pull requests with a solved GitHub issue and new feature
+* Pull request with a new content.

README.md

@@ -106,3 +106,26 @@ To mount your logs path to the container and automatically run the netflow label
 ```bash
 docker run -v /full/path/to/logs/:/netflowlabeler/data --rm -it stratosphereips/netflowlabeler:latest python3 netflowlabeler.py -c data/labels.config -f data/conn.log
 ```
+
+# Netflow Labeler High Level Diagram
+
+```mermaid
+flowchart LR;
+    NetFlow["Netflow File"]-->labeler;
+    Config["Labels Config"]-->labeler;
+    subgraph ONE["Interpret Input File"]
+        labeler-->load_conditions;
+        load_conditions-->process_netflow;
+        process_netflow-->define_type;
+        define_type-->define_columns;
+    end
+    subgraph TWO["Label NetFlow File"]
+        define_columns-.->process_argus;
+        define_columns-.->process_nfdump;
+        define_columns-->process_zeek;
+        process_argus-.->output_netflow_line_to_file;
+        process_nfdump-.->output_netflow_line_to_file;
+        process_zeek-->output_netflow_line_to_file;
+    end
+    output_netflow_line_to_file-->Output["Labeled NetFlow File"];
+```