Skip to content

Commit

Permalink
doc(readme): improve readme copy
Browse files Browse the repository at this point in the history
  • Loading branch information
xizhao committed Mar 6, 2018
1 parent 6a72302 commit b8a2912
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@
</p>

## Background
`fossa` analyzes complex codebases to generate dependency reports and license notices. By interrogating build environments, it generates fast and highly accurate results.
`fossa` analyzes complex codebases to generate dependency reports and license notices. By leveraging existing build environments, it can generate fast and highly-accurate results.

**Features:**

- Supports [over 15+ build systems](docs/how-it-works.md) (npm, golang, maven, gradle, etc...)
- Auto-configures for monoliths; just run `fossa` and it will detect multiple builds in one codebase
- Auto-configures for monoliths; instantly handles multiple builds in large codebases
- Fast and portable; a single cross-platform binary you can drop into CI or dev machines
- Generates dependency reports locally or hosted at https://fossa.io (for audit-grade license scans, policy enforcement and more...)

Expand All @@ -34,7 +34,7 @@ curl https://raw.githubusercontent.com/fossas/fossa-cli/master/install.sh | bash

We support Windows, MacOS (Darwin), and Linux amd64 machines.

## QuickStart
## Quick Start

Run and output report in JSON:
```bash
Expand All @@ -45,7 +45,10 @@ fossa -o
Remove `-o` and provide a [FOSSA API Key (docs)](https://fossa.io/docs/projects/api-endpoints/) to get a rich, hosted report:

```bash
FOSSA_API_KEY=YOUR_API_KEY_HERE fossa
export FOSSA_API_KEY="YOUR_API_KEY_HERE"

# Now, you can just run `fossa`!
fossa
```

## Configuration
Expand Down

0 comments on commit b8a2912

Please sign in to comment.