Skip to content

Commit 571efc1

Browse files
authored
docs: add description and usage (#20)
Updated README with brief description and usage.
1 parent f7ca6de commit 571efc1

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
1-
# Orb
1+
# Security Orb [![CircleCI Build Status](https://circleci.com/gh/ExtensionEngine/pipeline-security-orb.svg?style=shield "CircleCI Build Status")](https://circleci.com/gh/ExtensionEngine/pipeline-security-orb) [![CircleCI Orb Version](https://badges.circleci.com/orbs/studion/security.svg)](https://circleci.com/developer/orbs/orb/studion/security) [![GitHub License](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/ExtensionEngine/pipeline-security-orb/master/LICENSE) [![CircleCI Community](https://img.shields.io/badge/community-CircleCI%20Discuss-343434.svg)](https://discuss.circleci.com/c/ecosystem/orbs)
22

3-
[![CircleCI Build Status](https://circleci.com/gh/ExtensionEngine/pipeline-security-orb.svg?style=shield "CircleCI Build Status")](https://circleci.com/gh/ExtensionEngine/pipeline-security-orb) [![CircleCI Orb Version](https://badges.circleci.com/orbs/studion/security.svg)](https://circleci.com/developer/orbs/orb/studion/security) [![GitHub License](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/ExtensionEngine/pipeline-security-orb/master/LICENSE) [![CircleCI Community](https://img.shields.io/badge/community-CircleCI%20Discuss-343434.svg)](https://discuss.circleci.com/c/ecosystem/orbs)
3+
An orb to facilitate security work within Studion CircleCI pipelines. Inspired by [ASH](https://github.com/awslabs/automated-security-helper).\
4+
Key features:
5+
- Audit dependencies for vulnerabilities, supports npm or pnpm
6+
- The default value of the package manager is picked from the environment
7+
- Detect secret leaks on the changeset or target a directory
8+
- Run a diff-aware static analysis tool to detect vulnerabilities
9+
- Opt for a full scan of the codebase when needed
410

5-
## Resources
11+
## Usage
612

7-
[CircleCI Orb Registry Page](https://circleci.com/developer/orbs/orb/studion/security) - The official registry page of this orb for all versions, executors, commands, and jobs described.
13+
See [the official registry page](https://circleci.com/developer/orbs/orb/studion/security) of this orb for guidelines and examples.

0 commit comments

Comments
 (0)