Skip to content

Commit

Permalink
Added .travis.yml.
Browse files Browse the repository at this point in the history
  • Loading branch information
apersaud committed Jul 31, 2016
1 parent ea980d8 commit f84ea78
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 7 deletions.
5 changes: 5 additions & 0 deletions .travis.yml
@@ -0,0 +1,5 @@
language: perl
perl:
- "5.22"
- "5.20"
- "5.18"
15 changes: 8 additions & 7 deletions README.md
Expand Up @@ -6,7 +6,7 @@ This module implements a interface to the information contained in an nmap scan.
The latest version of this module can be found on here [http://modernistik.github.com/Nmap-Parser/](http://modernistik.github.com/Nmap-Parser/)

## Overview
Here is a samll example on how to use the module. You can view the more detailed API and examples in the POD documentation.
Here is a small example on how to use the module. You can view the more detailed API and examples in the POD documentation.

```perl
use Nmap::Parser;
Expand Down Expand Up @@ -38,7 +38,7 @@ Another method is to setup callbacks for each section.
#.. see documentation for all methods ...
}
```

## CPAN Installation (recommended)
The easiest way to install a Perl module is to use span. Run this in the command prompt to install directly from CPAN (may need root priviledges):

Expand All @@ -47,14 +47,15 @@ The easiest way to install a Perl module is to use span. Run this in the command
# or cpan bin
$ cpan install Nmap::Parser
```

## Manual Install
Download the file and unpack. This is usually done by:

$ tar zxvf Nmap-Parser-x.xx.tar.gz

Where x.xx is the version number. Next change into the newly created directory. To install this module type the following:

$ cpanm --quiet --installdeps --notest .
$ perl Makefile.PL
$ make
$ make test
Expand All @@ -72,26 +73,26 @@ To install it on Windows, you may need to have installed the ActiveState Perl Pa
ppm install Nmap-Parser

This should contact the ActiveState respository, download the file and install it automagically.

### Dependencies
This module requires these other modules and libraries:

* XML::Twig 3.16+
* Storable (comes with Perl 5+)

In addition, you will need nmap 3.00+. You don't exactly need it, but this
version of nmap supports the xml output that this module can parse. So, you do
not really need the executable, but the xml output that you will be parsing
(or able to parse), must be from this version onward.

### Issues, Bugs and Feature Requests
Please submit any bugs or feature requests to: [https://github.com/apersaud/Nmap-Parser/issues](https://github.com/apersaud/Nmap-Parser/issues)
Please submit any bugs or feature requests to: [https://github.com/modernistik/Nmap-Parser/issues](https://github.com/modernistik/Nmap-Parser/issues)

Please make sure that you submit the xml-output file of the scan which you are having
trouble with. This can be done by running your scan with the `-oX filename.xml` nmap switch. Please remove any important IP addresses for security reasons. It saves time in reproducing issues.

### Copyright and License
Copyright (C) 2003-2011 Anthony Persaud [http://www.modernistik.com](http://www.modernistik.com)
Copyright (C) 2003-2016 Anthony Persaud [http://www.modernistik.com](http://www.modernistik.com)

MIT License

Expand Down

0 comments on commit f84ea78

Please sign in to comment.