diff --git a/README.md b/README.md index 1f886b8c1030875673d41b6b584c8d111f4b273e..569d4d67b910b9a45f5818dd2c5a3f14adc68a3c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,16 @@ [![Code Climate](https://codeclimate.com/github/failmap/admin/badges/gpa.svg)](https://codeclimate.com/github/failmap/admin) [![Build Status](https://travis-ci.org/failmap/admin.svg?branch=master)](https://travis-ci.org/failmap/admin) [![Test Coverage](https://codeclimate.com/github/failmap/admin/badges/coverage.svg)](https://codeclimate.com/github/failmap/admin/coverage) +# Introduction +Failmap is a web application that continuously scans and evaluates (government) organization websites for security best practices and allows these results to be published on a map. + +This repository contains the main application of Failmap, it consists of a public web frontend, a administrative interface and scanners. + +To run a local testing/development instance see the instructions below. + +For a public production installation please refer to: https://gitlab.com/failmap/server + +![screenshot](docs/screenshot.png) + # Support fail map We keep organizations on their toes to protect everyone's data. Do you like this? Your donation insures continuous support, updates, and new features. diff --git a/docs/screenshot.png b/docs/screenshot.png new file mode 100644 index 0000000000000000000000000000000000000000..70237f068513877b09a06bb9df23720ac53c6bb7 Binary files /dev/null and b/docs/screenshot.png differ