init

1 files changed, 51 insertions, 0 deletions

diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..4d163c1
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,51 @@
+etap2pcap
+=========
+
+`Tibbo Ethernet Tap <https://tibbo.com/store/ninja/ninja-ethernet-tap.html>`_
+pcap logger.
+
+
+Requirements
+------------
+
+* python >=3.8
+* libusb-1.0
+
+
+Install
+-------
+
+::
+
+    $ pip install etap2pcap
+
+
+Run
+---
+
+::
+
+    $ etap2pcap path/to/output.pcap
+
+
+If output pcap already exists, new packages are appended.
+
+
+License
+-------
+
+etap2pcap - Tibbo Ethernet Tap pcap logger
+Copyright (C) 2021 Bozo Kopic
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.