From 1d1fd16fe052abcf2b3eb8d53d4557dd28a7228c Mon Sep 17 00:00:00 2001 From: Liran Tal Date: Sun, 10 Mar 2019 14:59:32 +0200 Subject: [PATCH] docs: update layout for project page --- README.md | 50 +++++++++++++++++++++++++------------------------- 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index bca064cbc2..59ef8c3489 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,30 @@ -![Snyk logo](https://snyk.io/style/asset/logo/snyk-print.svg) +

+ +

---- +

+ Documentation | + Test your project +

+ +

+ Snyk helps you find, fix and monitor known vulnerabilities in open source +

-[![Known Vulnerabilities](https://snyk.io/test/npm/snyk/badge.svg)](https://snyk.io/test/npm/snyk) +

+ Known Vulnerabilities + Monthly Downloads +

-Snyk helps you find, fix and monitor known vulnerabilities in Node.js npm, Ruby and Java dependencies, both on an ad hoc basis and as part of your CI (Build) system. +--- -## Documentation +## What is Snyk? -[Full documentation is available on snyk.io](https://snyk.io/docs/using-snyk/?utm_campaign=docs&utm_medium=github&utm_source=full_docs) +

+ + What is Snyk? + +

## Table Of Contents: @@ -178,28 +194,12 @@ docker run -it ## Badge -Once you’re vulnerability-free, you can put a badge on your README showing your package has no known security holes. This will show your users you care about security, and tell them that they should care too. - -If there are no vulnerabilities, this is indicated by a green badge. - -[![Known Vulnerabilities](https://snyk.io/package/npm/name/badge.svg)](https://snyk.io/package/npm/name) - -If vulnerabilities have been found, the red badge will show the number of vulnerabilities. - -[![Known Vulnerabilities](https://snyk.io/package/npm/jsbin/badge.svg)](https://snyk.io/package/npm/jsbin) - -Get the badge by copying the relevant snippet below and replacing "name" with the name of your package. - -HTML: - -``` -Known Vulnerabilities -``` +You can put a badge on your README showing your package has no known security holes. This will show your users you care about security, and tell them that they should care too. -Markdown: +Known Vulnerabilities ``` -[![Known Vulnerabilities](https://snyk.io/package/npm/name/badge.svg)](https://snyk.io/package/npm/name) +[![Known Vulnerabilities](https://snyk.io/package/npm/snyk/badge.svg)](https://snyk.io/package/npm/snyk) ``` [![Analytics](https://ga-beacon.appspot.com/UA-69111857-2/Snyk/snyk?pixel)](https://snyk.io/)