A modern platform for visual, flexible, and extensible graph-based investigations. For cybersecurity analysts and investigators.
feat: update readme
dextmorgn0619550107bc
diff --git a/Makefile b/Makefileindex 515be3d1..2a4b5272 100644--- a/Makefile+++ b/Makefile@@ -75,3 +75,6 @@ clean:rm -rf $(PROJECT_ROOT)/flowsint-core/.venvrm -rf $(PROJECT_ROOT)/flowsint-transforms/.venvrm -rf $(PROJECT_ROOT)/flowsint-api/.venv+++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diff --git a/README.md b/README.mdindex bf82a680..cf8314cd 100644--- a/README.md+++ b/README.md@@ -38,18 +38,12 @@ flowsint-types (types)- Poetry (for dependency management)- Docker (for some tools)-### Installation+### Run-1. Run the install script+For now, you can start flowsint in a development environment. It's pretty performant already ! And fully local stored. Make sure you have **Make** installed.```bash-chmod +x ./install.sh-```--### Run the services--```bash-chmod +x ./start.sh+make dev```An electron app should start, frontend is also accessible at [http://localhost:5173](http://localhost:5173).diff --git a/flowsint-core/README.md b/flowsint-core/README.mdnew file mode 100644index 00000000..ea792210--- /dev/null+++ b/flowsint-core/README.md@@ -0,0 +1,14 @@+# flowsint-core+The repository containing the core components for flowsint.++It contains:+- Celery tasks+- Authentication+- NEO4J database connectors+- POSTGRESQL database connectors+- Transform base class+- Transform orchestrator+- Transform registry+- Encrypted vault++> ⚠️ 🚧 Work in progress !.diff --git a/flowsint-transforms/README.md b/flowsint-transforms/README.mdindex 188130f0..4b00e8d7 100644--- a/flowsint-transforms/README.md+++ b/flowsint-transforms/README.md@@ -1,4 +1,4 @@# flowsint-transformsThe repository containing open-source transforms for flowsint.-> ⚠️ 🚧 Work in progress ! No ready yet.\ No newline at end of file+> ⚠️ 🚧 Work in progress !.diff --git a/flowsint-types/README.md b/flowsint-types/README.mdindex 660faa22..ae01189b 100644--- a/flowsint-types/README.md+++ b/flowsint-types/README.md@@ -2,4 +2,4 @@The types used in the flowsint transforms and core for flowsint.-> ⚠️ 🚧 Work in progress ! No ready yet.\ No newline at end of file+> ⚠️ 🚧 Work in progress !.