From be63c6a231577e91ab7eee66dcbf2a5164699058 Mon Sep 17 00:00:00 2001 From: Brendan LE GLAUNEC Date: Tue, 26 Sep 2017 09:51:17 +0200 Subject: [PATCH] Add package overview & fix dead link --- README.md | 2 +- cmrdr.go | 14 ++++++++++++++ 2 files changed, 15 insertions(+), 1 deletion(-) create mode 100644 cmrdr.go diff --git a/README.md b/README.md index 3f1f1ed..761d42b 100644 --- a/README.md +++ b/README.md @@ -133,7 +133,7 @@ With the above result, the RTSP URL would be `rtsp://admin:12345@173.16.100.45:5 ## Contribution -See [the contribution document](/CONTRIBUTION.md) to get started. +See [the contribution document](/CONTRIBUTING.md) to get started. ## Frequently Asked Questions diff --git a/cmrdr.go b/cmrdr.go new file mode 100644 index 0000000..38476c0 --- /dev/null +++ b/cmrdr.go @@ -0,0 +1,14 @@ +// Package cmrdr provides methods to be able to discover and +// attack RTSP streams easily. RTSP streams are used by most +// IP Cameras, often for surveillance. +// +// A simple example usage of the library can be found in +// https://github.com/EtixLabs/cameradar/tree/master/cameraccess +// +// The example usage is complete enough for most users to +// ignore the library, but for users with specific needs +// such as creating their own bruteforcing dictionary to +// access cameras, or running their own network scan, this +// library allows to use simple and performant methods to +// attack streams. +package cmrdr