Skip to content

Commit db88a9a

Browse files
committed
Update README
1 parent e397991 commit db88a9a

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

README.md

+8-10
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
![alt python_version](https://img.shields.io/badge/python-3.5+-informational.svg)
44
![alt tests_coverage](https://img.shields.io/badge/tests%20coverage-94%25-success.svg)
5+
[![Build Status](https://travis-ci.com/ShellCode33/CredSLayer.svg?branch=master)](https://travis-ci.com/ShellCode33/CredSLayer)
56

67
CredSLayer goal is to look for credentials and other useful stuff in network captures. Two modes are available, pcap scanning and active processing. The latest listens for packets on a chosen interface and dynamically extracts everything it can.
78

@@ -28,24 +29,21 @@ It is also able to look for email addresses and credit card numbers.
2829

2930
# Install
3031

31-
You need Wireshark installed and Python >= 3.5, then do the following :
32+
You need `tshark` installed and Python >= 3.5. On some distribution tshark in shipped within the `wireshark` package.
33+
34+
Then simply install using :
3235

3336
```
34-
$ git clone https://github.com/ShellCode33/CredSLayer.git
35-
$ cd CredSLayer/
36-
$ python3 -m venv venv
37-
$ . venv/bin/activate
38-
$ pip install -r requirements.txt
39-
$ python CredSLayer.py -h
37+
$ pip install credslayer
4038
```
4139

42-
pip package coming soon...
40+
I recommend you use a [virtualenv](https://docs.python.org/3/library/venv.html) to prevent conflicts.
4341

4442
# Usage
4543

4644
```
47-
$ python CredSLayer.py -h
48-
usage: CredSLayer.py [-h] [-l INTERFACE] [-s {enable,disable}] [-f IP]
45+
$ credslayer -h
46+
usage: credslayer [-h] [-l INTERFACE] [-s {enable,disable}] [-f IP]
4947
[-m PORT:PROTOCOL] [--debug]
5048
[pcapfiles [pcapfiles ...]]
5149

0 commit comments

Comments
 (0)