Commit 7fb78c0

@@ -0,0 +1,2 @@
+/src/
+/venv/

@@ -0,0 +1,43 @@
+# `gowarcprox`
+
+`gowarcprox` is a rewrite of `internetarchive/warcprox` in golang heavily 
+relying on the features provided by `internetarchive/gowarc`. The rewritten
+software should emulate all of the observable features and 
+
+## git
+
+- The source repos and venv directories (`src` and `venv`) should not be 
+  commited to this repo
+  - They are added to the `.gitignore` for this project
+- Planned implementations should utilize git commits and branches as 
+  appropriate for keeping track of work accomplished, ready for testing, review,
+  and merging.
+- An remote origin has been setup, however remote fetch and push will require 
+  a physical key touch (yubikey) and shouldn't be attempted by agents.
+
+## source repos 
+
+### `internetarchive/warcprox`
+
+A git checkout of `https://github.com/internetarchive/warcprox` is provided as
+a source of inspection and functional information for the original project.
+
+### `internetarchive/gowarc`
+
+A git checkout of `https://github.com/internetarchive/gowarc` is provided as
+a source of inspection and documenation information for the `gowarc` library.
+
+### `uber-go/guide`
+
+A git checkout of `https://github.com/uber-go/guide.git` is provided as
+a source of inspection and documenation information for golang style guide. 
+All reccomendations and guidelines from this repo should be followed.
+
+## venv
+
+A python virtual environment is provided at `./venv` and has the warxprox installed.
+- Use with `./venv/bin/warcprox` for testing functionality of the original repo.
+
+## golang: prefered libraries
+
+- https://github.com/spf13/cobra.git - for cli flags and argument parsing