updating readme

README.md

@@ -1,2 +1,48 @@
 # ansible-debian-baseline
 
+This ansible role provides a common baseline configuration for debian hosts.
+Not designed for docker containers.
+
+---
+
+This project is forked from the [Guardian Project Ops](https://gitlab.com/guardianproject-ops/) collection.
+
+It's free and open source made available under the the [GNU Affero General Public v3 License](LICENSE.md).
+
+## Introduction
+
+* upgrade all installed packages
+* install useful tools:
+  - locales
+  - htop
+  - debsums
+  - vim-tiny
+  - unattended-upgrades
+  - acl
+  - dirmngr # Debian Stretch requires dirmngr package to be installed in order to use apt_key
+  - unbound # DNSSEC validation
+  - lsof
+  - ncdu
+  - tmux
+* motd w/ ansible message
+* enable unattended-upgrades security only
+* enable and configure ntp client
+
+## Requirements
+
+This role only supports Debian hosts.
+
+Requires the [`ansible-debian-ntp`](https://git.bitpack.io/hub/ansible-debian-ntp) role
+
+## Usage
+
+```yaml
+- hosts: servers
+  roles:
+    - ansible-debian-baseline
+```
+
+## Role Variables
+
+* `debian_baseline_motd_enabled`: `true` - whether to install an motd stating that this box is ansible managed
+