summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDamian Johnson <atagar@torproject.org>2018-08-05 13:02:55 -0700
committerDamian Johnson <atagar@torproject.org>2018-08-05 13:02:55 -0700
commitdf75072444c046586c2f931625b947f3cd08d543 (patch)
tree3c3d2f1866e734d8704d3884fa6685d79e49eaf9
parent8ec17d804e7f6142fae0f14120bdf06e523e3982 (diff)
Readme stub for github
Github uses readmes for its front page so providing a little pointer to our site. https://trac.torproject.org/projects/tor/ticket/26224
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..225b38d8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,6 @@
+## Stem (Python Tor Library)
+
+
+Stem is a Python controller library for **[Tor](https://www.torproject.org/)**. With it you can use Tor's [control protocol](https://gitweb.torproject.org/torspec.git/tree/control-spec.txt) to script against the Tor process, or build things such as [Nyx](https://nyx.torproject.org/).
+
+Documentation and tutorials available at **[stem.torproject.org](https://stem.torproject.org/)**.