summary history branches tags files
commit:bd004bb8608b8596f5fd62df38153fccfc3b0f76
author:Trevor Bentley
committer:Trevor Bentley
date:Wed Dec 9 18:43:04 2020 +0100
parents:4fe9737f8bc5a8fea891f54842403399df4572af
sync README
diff --git a/README.md b/README.md
line changes: +52/-3
index 1323765..373b7f3
--- a/README.md
+++ b/README.md
@@ -103,6 +103,35 @@ several lines:
 >    :port 80)
 
 
+=== GETTING SNITCH ===
+
+snitch is not currently published in any package repositories
+(*ELPA).  It can be installed by any package manager that supports
+git repositories, or manually.
+
+quelpa:
+
+>  (quelpa '(snitch :repo "mrmekon/snitch-el" :fetcher github))
+
+use-package + quelpa + quelpa-use-package:
+
+>  (use-package snitch
+>    :quelpa (snitch :repo "mrmekon/snitch-el" :fetcher github))
+
+el-get:
+
+>  (el-get-bundle mrmekon/snitch-el)
+
+straight.el:
+
+>  (straight-use-package
+>    '(snitch :type git :host github :repo "mrmekon/snitch-el"))
+
+manual:
+
+>  (package-install-file "/path/to/snitch-x.y.z.tar")
+
+
 === USAGE ===
 
 Enabling snitch is as simple as calling ‘(snitch-init)’.
@@ -110,10 +139,14 @@ Initialization does very little, so this is safe to call in your
 emacs init without worrying about deferral or negative consequences
 on startup time.
 
+The minimum required initialization is simply:
+
+>  (require ’snitch)
+>  (snitch-init)
+
 An example initialization using ‘use-package’ might look like so:
 
 >  (use-package snitch
->    :ensure t
 >    :config
 >    (snitch-init))
 
@@ -173,7 +206,6 @@ demonstrates permitting only the ’elfeed’ package to create network
 connections:
 
 >  (use-package snitch
->    :ensure t
 >    :config
 >    (setq snitch-network-policy 'deny)
 >    (setq snitch-process-policy 'deny)
@@ -189,7 +221,6 @@ Another useful configuration is to allow all accesses, but log them
 to keep an audit trail.  This might look like so:
 
 >  (use-package snitch
->    :ensure t
 >    :config
 >    (setq snitch-network-policy 'allow)
 >    (setq snitch-process-policy 'allow)
@@ -434,6 +465,24 @@ to the socket.
  - profit!
 
 
+=== VERSION HISTORY ===
+
+v0.2.0 (2020-12-09)
+
+  - first published version
+
+v0.1.0 (before 2020-12-09)
+
+  - Initial development and testing
+  - Network and process firewall functionality
+  - Audit logging
+  - Whitelist + blacklist filtering
+  - Backtrace processing
+  - Timer backtrace expansion
+  - User event and logging hooks
+  - ert test framework
+
+
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 
 This program is free software; you can redistribute it and/or modify