diff --git a/README.md b/README.md index 36c443c..4edcee8 100644 --- a/README.md +++ b/README.md @@ -2,16 +2,29 @@ ======= Public shared workflow templates and reusable workflows for Trail of Bits. -You can find our public profile and repositories at https://github.com/trailofbits/ +You can find our public profile and repositories at https://github.com/trailofbits/. -**.github/workflows** +## .github/workflows -Github Actions [reusable workflows](https://docs.github.com/en/actions/using-workflows/reusing-workflows) +Github Actions [reusable workflows](https://docs.github.com/en/actions/using-workflows/reusing-workflows). -**workflow-templates** +You can call these workflows from a workflow in your repo like: + +```yaml +jobs: + lint: + uses: trailofbits/.github/.github/workflows/lint.yml@v0.1.0 +``` + +## workflow-templates Github Actions templates you can use from your repo -> Actions -> New workflow -**profile** +Learn more about [creating starter workflows](https://docs.github.com/en/actions/using-workflows/creating-starter-workflows-for-your-organization) and [using starter workflows](https://docs.github.com/en/actions/using-workflows/using-starter-workflows) + +This is an example of using our pip-audit starter workflow: +image + +## profile -Our [Github organization's](https://github.com/trailofbits) public profile +Our [Github organization's](https://github.com/trailofbits) public profile.