README.md
1# HTTP-Cache-Transparent
2
3HTTP::Cache::Transparent is an implementation of http get that keeps a local
4cache of fetched pages to avoid fetching the same data from the server
5if it hasn't been updated. The cache is stored on disk and is thus
6persistent between invocations.
7
8The http-headers If-Modified-Since and ETag are used to let the server
9decide if the version in the cache is up-to-date or not.
10
11HTTP::Cache::Transparent was initially called HTTP::TransparentCache. It
12was renamed on request from modules@perl.org.
13
14## Limitations
15
16This module has a number of limitations that you should be aware of
17before using it. They are documented in the POD-documentation for the
18module.
19
20## Installation
21
22To install this module type the following:
23
24 perl Makefile.PL
25 make
26 make test
27 make install
28
29## Dependencies
30
31- LWP
32- Storable (included with perl)
33- Digest::MD5 (included with perl)
34
35All http-requests are made through the LWP module. Data is stored on disk
36by the Storable module. Digest::MD5 is used for creating a hash of the
37url.
38
39## Git repository
40
41A git repository with the sourcecode for HTTP::Cache::Transparent can
42be found at https://github.com/mattiash/HTTP-Cache-Transparent.
43
44## Copyright and license
45
46Copyright (C) 2004-2017 by Mattias Holmlund
47
48This library is free software; you can redistribute it and/or modify
49it under the same terms as Perl itself, either Perl version 5.8.4 or,
50at your option, any later version of Perl 5 you may have available.
51
52
53