summary history branches tags files
commit:4c8256e083985b65af6ff741a311fcc9d4da1a8c
author:Trevor Bentley
committer:Trevor Bentley
date:Wed Dec 9 18:24:26 2020 +0100
parents:1e53ea692cb820de3054f1b9774891302586adb3
package documentation: getting, version history
diff --git a/snitch.el b/snitch.el
line changes: +52/-3
index 39aa55b..a21b816
--- a/snitch.el
+++ b/snitch.el
@@ -119,6 +119,35 @@
 ;; >    :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)’.
@@ -126,10 +155,14 @@
 ;; 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))
 ;;
@@ -189,7 +222,6 @@
 ;; connections:
 ;;
 ;; >  (use-package snitch
-;; >    :ensure t
 ;; >    :config
 ;; >    (setq snitch-network-policy 'deny)
 ;; >    (setq snitch-process-policy 'deny)
@@ -205,7 +237,6 @@
 ;; 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)
@@ -450,6 +481,24 @@
 ;;  - 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