Merge pull request #6 from ubc-provenance/dev

Release notes

Author: TristanBilot

README.md

@@ -1,28 +1,14 @@
-[![Support Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue)](https://code.visualstudio.com/docs/devcontainers/create-dev-container)
 [![Documentation](https://img.shields.io/badge/docs-online-pink.svg)](https://ubc-provenance.github.io/PIDSMaker/)
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.15603122.svg)](https://doi.org/10.5281/zenodo.15603122)
-
-# Sometimes Simpler is Better: A Comprehensive Analysis of State-of-the-Art Provenance-Based Intrusion Detection Systems
-
-# Citation
-
-If you use this work, please cite the following paper:
-```
-@inproceedings{bilot2025simpler,
-	title={{Sometimes Simpler is Better: A Comprehensive Analysis of State-of-the-Art Provenance-Based Intrusion Detection Systems}},
-	author={Bilot, Tristan and Jiang, Baoxiang and  Li, Zefeng and  El Madhoun, Nour and Al Agha, Khaldoun and Zouaoui, Anis and Pasquier, Thomas},
-	booktitle={Security Symposium (USENIX Sec'25)},
-	year={2025},
-	organization={USENIX}
-}
-```
+![GitHub License](https://img.shields.io/github/license/ubc-provenance/PIDSMaker)
 
 # 🥷 PIDSMaker
 
 The first framework designed to build and experiment with provenance-based intrusion detection systems (PIDSs) using deep learning architectures.
 It provides a single codebase to run most recent state-of-the-arts systems and easily customize them to develop new variants.
 
 **Currently supported PIDSs**:
+- Velox (USENIX Sec'25): [Sometimes Simpler is Better: A Comprehensive Analysis of State-of-the-Art Provenance-Based Intrusion Detection Systems](https://tfjmp.org/publications/2025-usenixsec-2.pdf)
 - Orthrus (USENIX Sec'25): [ORTHRUS: Achieving High Quality of Attribution in Provenance-based Intrusion Detection Systems](https://www.usenix.org/system/files/conference/usenixsecurity25/sec25cycle1-prepub-103-jiang-baoxiang.pdf)
 - R-Caid (IEEE S\&P'24): [R-CAID: Embedding Root Cause Analysis within Provenance-based Intrusion Detection](https://gangw.web.illinois.edu/rcaid-sp24.pdf)
 - Flash (IEEE S\&P'24): [Flash: A Comprehensive Approach to Intrusion Detection via Provenance Graph Representation Learning](https://dartlab.org/assets/pdf/flash.pdf)
@@ -40,7 +26,11 @@ git clone https://github.com/ubc-provenance/PIDSMaker.git
 
 ### ⏰ 10-min Docker Install with DARPA TC/OpTC Datasets
 
-We have made the installation of DARPA TC/OpTC easy and fast, simply follow [these guidelines](docs/docs/ten-minute-install.md).
+We have made the installation of DARPA TC/OpTC easy and fast, simply follow [these guidelines](http://localhost:8000/PIDSMaker/ten-minute-install/).
+
+## Documentation
+
+A comprehensive [documentation](https://ubc-provenance.github.io/PIDSMaker/) is available, explaining all possible arguments and providing examples on how integrating new systems.
 
 ## Basic usage of the framework
 
@@ -65,6 +55,19 @@ Once you have a shell in the pids container, experiments can be run in multiple
     ```
     You can still watch the logs in your shell using `tail -f nohup.out`
 
+## Citation
+
+If you use this work, please cite the following paper:
+```
+@inproceedings{bilot2025simpler,
+	title={{Sometimes Simpler is Better: A Comprehensive Analysis of State-of-the-Art Provenance-Based Intrusion Detection Systems}},
+	author={Bilot, Tristan and Jiang, Baoxiang and  Li, Zefeng and  El Madhoun, Nour and Al Agha, Khaldoun and Zouaoui, Anis and Pasquier, Thomas},
+	booktitle={Security Symposium (USENIX Sec'25)},
+	year={2025},
+	organization={USENIX}
+}
+```
+
 ## License
 
 See [licence](LICENSE).

docs/docs/release_notes.md

@@ -9,15 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [1.0.0] - 2017-06-20
-### Added
-- TODO
-- TODO
-
-### Changed
-- TODO
-- TODO
-
-### Removed
-- TODO
-- TODO
+## [1.0.0] - 2025-06-05
+- Initial release
+- Systems: Velox, Orthrus, R-Caid, Flash, Kairos, Magic, NodLink, ThreaTrace
+- Datasets: CLEARSCOPE_E3, CADETS_E3, THEIA_E3, CLEARSCOPE_E5, THEIA_E5, optc_h201, optc_h501, optc_h051