SECURITY.md

README.md

@@ -1,3 +1,13 @@
 # world-id-relay
 
 Service to bridge World ID roots from Ethereum to various Layer 2s
+
+### Running
+
+For a simple configuration example please see the config.stage.toml.
+
+You can run the `world-id-relay` with
+
+```bash
+cargo run -- --config my_config.toml
+```

SECURITY.md

@@ -0,0 +1,15 @@
+# Report a security issue
+
+The project team welcomes security reports and is committed to providing prompt attention to security issues. Security issues should be reported privately via [remco@wicked.ventures](mailto:remco@wicked.ventures). Security issues should not be reported via the public Github Issue tracker.
+
+## Vulnerability coordination
+
+Remediation of security vulnerabilities is prioritized by the project team. The project team coordinates remediation with third-party project stakeholders via [Github Security Advisories](https://help.github.com/en/github/managing-security-vulnerabilities/about-github-security-advisories). Third-party stakeholders may include the reporter of the issue, affected direct or indirect users of this project, and maintainers of upstream dependencies if applicable.
+
+Downstream project maintainers and users can request participation in coordination of applicable security issues by sending your contact email address, Github username(s) and any other salient information to [remco@wicked.ventures](mailto:remco@wicked.ventures). Participation in security issue coordination processes is at the discretion of the project team.
+
+## Security advisories
+
+The project team is committed to transparency in the security issue disclosure process. The project team announces security issues via [project Github Release notes](https://github.com/Recmo/rust-app-template/releases) and the [RustSec advisory database](https://github.com/RustSec/advisory-db) (i.e. `cargo-audit`).
+
+<!-- Based on https://github.com/tokio-rs/tokio/blob/tokio-1.13.0/SECURITY.md -->