[tor-commits] [nyx/master] Basic readme

[atagar at torproject.org]

commit 5053f5ea693c205096e673dbc3754a5ea06a5fd9
Author: Damian Johnson <atagar at torproject.org>
Date:   Sat Dec 21 13:31:26 2019 -0800

    Basic readme
    
    Adding a basic readme similar to Stem's for our GitHub page.
---
 README.md | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..480f063
--- /dev/null
+++ b/README.md
@@ -0,0 +1,6 @@
+## Nyx (Tor Command-line Monitor)
+
+
+Nyx is a command-line monitor for **[Tor](https://www.torproject.org/)**. With this you can get detailed real-time information about your relay such as bandwidth usage, connections, logs, and much more.
+
+Documentation and screenshots available at **[nyx.torproject.org](https://nyx.torproject.org/)**.