Skip to content

Commit

Permalink
Merge pull request #30 from spekulatius/readme-enhancements
Browse files Browse the repository at this point in the history
Improving readability
  • Loading branch information
spekulatius authored Jul 9, 2016
2 parents 315c720 + 56f3782 commit 5f8166e
Showing 1 changed file with 5 additions and 10 deletions.
15 changes: 5 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,20 @@
# [SilverStripe composer security checker](https://github.com/spekulatius/silverstripe-composer-security-checker)
# [SilverStripe composer security checker](https://github.com/spekulatius/silverstripe-composer-security-checker) <br /> [![Build Status](https://api.travis-ci.org/spekulatius/silverstripe-composer-security-checker.svg?branch=master)](https://travis-ci.org/spekulatius/silverstripe-composer-security-checker) [![Latest Stable Version](https://poser.pugx.org/spekulatius/silverstripe-composer-security-checker/version.svg)](https://github.com/spekulatius/silverstripe-composer-security-checker/releases) [![Latest Unstable Version](https://poser.pugx.org/spekulatius/silverstripe-composer-security-checker/v/unstable.svg)](https://packagist.org/packages/spekulatius/silverstripe-composer-security-checker) [![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/spekulatius/silverstripe-composer-security-checker.svg)](https://scrutinizer-ci.com/g/spekulatius/silverstripe-composer-security-checker?branch=master) [![Total Downloads](https://poser.pugx.org/spekulatius/silverstripe-composer-security-checker/downloads.svg)](https://packagist.org/packages/spekulatius/silverstripe-composer-security-checker) [![License](https://poser.pugx.org/spekulatius/silverstripe-composer-security-checker/license.svg)](https://github.com/spekulatius/silverstripe-composer-security-checker/blob/master/license.md)

Adds a task which runs a check if any of the dependencies has known security vulnerabilities. It uses the
[SensioLabs Security Check Web service][1] and the [Security Advisories Database][2].

*Because this module could expose information to an potential attacker the information doesn't get displayed!

You need to take care of processing this information somehow! E.g. using the [SilverStripe Maintenance module](https://github.com/FriendsOfSilverStripe/silverstripe-maintenance "supports you with the maintainence of your SilverStripe project")*
[![Build Status](https://api.travis-ci.org/spekulatius/silverstripe-composer-security-checker.svg?branch=master)](https://travis-ci.org/spekulatius/silverstripe-composer-security-checker)
[![Latest Stable Version](https://poser.pugx.org/spekulatius/silverstripe-composer-security-checker/version.svg)](https://github.com/spekulatius/silverstripe-composer-security-checker/releases)
[![Latest Unstable Version](https://poser.pugx.org/spekulatius/silverstripe-composer-security-checker/v/unstable.svg)](https://packagist.org/packages/spekulatius/silverstripe-composer-security-checker)
[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/spekulatius/silverstripe-composer-security-checker.svg)](https://scrutinizer-ci.com/g/spekulatius/silverstripe-composer-security-checker?branch=master)
[![Total Downloads](https://poser.pugx.org/spekulatius/silverstripe-composer-security-checker/downloads.svg)](https://packagist.org/packages/spekulatius/silverstripe-composer-security-checker)
[![License](https://poser.pugx.org/spekulatius/silverstripe-composer-security-checker/license.svg)](https://github.com/spekulatius/silverstripe-composer-security-checker/blob/master/license.md)

## Requirements

### Requirements

* SilverStripe Framework ^3.0
* SilverStripe QueuedJobs *


## Installation
### Installation

The following installation commands includes schedulding a queuedjob to populate the data. Run the following command to install this package as a development dependency:

Expand All @@ -40,7 +35,7 @@ php ./framework/cli-script.php dev/tasks/ProcessJobQueueTask
**Recommendation is to only install this as dev dependency!**


## Usage
### Usage

The information gets automatically updated via a queuedjob on dev/build. You will need to run the queuedjobs task to get the information.

Expand Down

0 comments on commit 5f8166e

Please sign in to comment.