about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorDavid Hill <dhill@conformal.com>2013-06-12 12:55:45 -0400
committerDavid Hill <dhill@conformal.com>2013-06-12 12:55:45 -0400
commit4796a7b23a916e74aabc3431418e4e598721cfc6 (patch)
treee4eb72260d450cae7a7be97d243b2a6d6d6d846d
parent34a81399bb708a71c298989a8778ffb7e168dd11 (diff)
downloadxombrero-4796a7b23a916e74aabc3431418e4e598721cfc6.tar.gz
add a README.md for Github
-rw-r--r--README.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b69db56
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+xombrero
+========
+
+xombrero is a minimalist web browser with sophisticated security
+features designed-in, rather than through an add-on after-the-fact. In
+particular, it provides both persistent and per-session controls for
+scripts and cookies, making it easy to thwart tracking and scripting
+attacks.  In additional to providing a familiar mouse-based interface
+like other web browsers, it offers a set of vi-like keyboard commands
+for users who prefer to keep their hands on their keyboard.  The default
+settings provide a secure environment. With simple keyboard commands,
+the user can "whitelist" specific sites, allowing cookies and scripts
+from those sites.
+
+## GPG Verification Key
+
+All official release tags are signed by Conformal so users can ensure the code
+has not been tampered with and is coming from Conformal.  To verify the
+signature perform the following:
+
+- Download the public key from the Conformal website at
+  https://opensource.conformal.com/GIT-GPG-KEY-conformal.txt
+
+- Import the public key into your GPG keyring:
+  ```bash
+  gpg --import GIT-GPG-KEY-conformal.txt
+  ```
+
+- Verify the release tag with the following command where `TAG_NAME` is a
+  placeholder for the specific tag:
+  ```bash
+  git tag -v TAG_NAME
+  ```
+
+## License
+
+xombrero is licensed under the liberal ISC License.