Skip to content

Commit 882a973

Browse files
author
Rory McCann
committed
better docs
1 parent a80944f commit 882a973

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,21 @@ Parses log lines from an apache log file in (almost) any format possible
22

33
[![Build Status](https://travis-ci.org/rory/apache-log-parser.png?branch=master)](https://travis-ci.org/rory/apache-log-parser)
44

5-
Usage:
5+
Installation
6+
============
7+
8+
pip install apache-log-parser
9+
10+
Usage
11+
=====
612

713
import apache_log_parser
814
line_parser = apache_log_parser.make_parser("%v %h %l %u %t \"%r\" %>s %b")
915

1016
This creates & returns a function, ``line_parser``, which accepts a line from an apache log file in that format, and will return the parsed values in a dictionary.
1117

12-
Example:
18+
Example
19+
=======
1320

1421
>>> import apache_log_parser
1522
>>> line_parser = apache_log_parser.make_parser("%h <<%P>> %t %Dus \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\" %l %u")
@@ -29,7 +36,10 @@ Example:
2936

3037
The version numbers follow [Semantic Versioning](http://semver.org/).
3138

32-
This package is © 2013 Rory McCann, released under the terms of the GNU GPL v3 (or at your option a later version)
39+
Copyright
40+
=========
41+
42+
This package is © 2013-2015 Rory McCann, released under the terms of the GNU GPL v3 (or at your option a later version). If you'd like a different licence, please email <[email protected]>
3343

3444

3545
[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/rory/apache-log-parser/trend.png)](https://bitdeli.com/free "Bitdeli Badge")

0 commit comments

Comments
 (0)