diff --git a/README.md b/README.md index f6b8347..0e8690b 100644 --- a/README.md +++ b/README.md @@ -10,3 +10,11 @@ Many of the APIs provided are meant to be drop-in replacements that either offer To install this package from PyPI, use the following command: `pip install security` + +## Running tests + +DO NOT RUN TESTS LOCALLY WITHOUT A VM/CONTAINER. + +Tests will try to run "dangerous" commands (i.e. curl, netcat, etc.) and try to access sensitive files (i.e. sudoers, passwd, etc.). We do so to test the our abilities to detect and filter these types of attacks. + +While all these commands are devised as innocuous, it is still not a good idea to risk exposure. They also require a specific environment to pass. We recommend using something like [act](https://github.com/nektos/act) to run the github workflow locally within a container for local development.