source: README @ 8bece4

Revision 8bece4, 3.8 KB checked in by Tomash Brechko <tomash.brechko@…>, 22 months ago (diff)

Increment version number to 0.19.

  • Property mode set to 100644
Line 
1Cache-Memcached-Fast version 0.19
2=================================
3
4Cache::Memcahced::Fast is a Perl client for memcached, a memory cache
5daemon (http://www.danga.com/memcached/).  Module core is implemented
6in C and tries hard to minimize number of system calls and to avoid
7any key/value copying for speed.  As a result, it has very low CPU
8consumption.
9
10API is largely compatible with Cache::Memcached, original pure Perl
11client, most users of the original module may start using this module
12by installing it and adding "::Fast" to the old name in their scripts
13(see "Compatibility with Cache::Memcached" section in the module
14documentation for full details).
15
16The module does not depend on any external library, it contains custom
17memcached client implementation in C designed for efficient
18interaction with Perl (actually client code has well defined generic
19API and may be used by itself).
20
21The module should compile and work on any Unix-derived system.  Win32
22support is based on the patch by Yasuhiro Matsumoto---thanks!, and is
23(expected to be) supported by community.  Note: on Win32 below Windows
24Vista max number of memcached servers is 64.  See comment on
25FD_SETSIZE in src/socket_win32.h to learn how to increase this value
26if you need to connect to more than 64 servers.
27
28Despite the low version number (which mainly reflects release history)
29the module is considered to be beta (see BUGS below on how to report
30bugs).  See "Compatibility with Cache::Memcached" section in the
31module documentation for the description of what is missing compared
32to Cache::Memcached.
33
34
35INSTALLATION
36
37Latest release of this module is available from CPAN:
38
39  http://search.cpan.org/dist/Cache-Memcached-Fast/
40
41Latest development tree is available from project home:
42
43  http://openhack.ru/Cache-Memcached-Fast
44
45
46To install this module type the following:
47
48   perl Makefile.PL
49   make
50   make test
51   make install
52
53Don't forget to start memcahced daemon on local host port 11211 (the
54default) before running 'make test'.
55
56
57DEPENDENCIES
58
59This module requires these other modules and software:
60
61  ANSI C compiler to compile module core
62
63  Test::More (required only to run tests)
64
65
66SUPPORT AND DOCUMENTATION
67
68After installing, you can find documentation for this module with the
69perldoc command.
70
71    perldoc Cache::Memcached::Fast
72
73You can also look for information at:
74
75    RT, CPAN's request tracker
76        http://rt.cpan.org/NoAuth/Bugs.html?Dist=Cache-Memcached-Fast
77
78    AnnoCPAN, Annotated CPAN documentation
79        http://annocpan.org/dist/Cache-Memcached-Fast
80
81    CPAN Ratings
82        http://cpanratings.perl.org/d/Cache-Memcached-Fast
83
84    Search CPAN
85        http://search.cpan.org/dist/Cache-Memcached-Fast
86
87
88BUGS
89
90Please report any bugs or feature requests to bug-cache-memcached-fast
91at rt.cpan.org, or through the web interface at
92http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Cache-Memcached-Fast.
93I will be notified, and then you'll automatically be notified of
94progress on your bug as I make changes.
95
96
97COPYRIGHT AND LICENCE
98
99Copyright (C) 2007-2010 Tomash Brechko.  All rights reserved.
100
101This library is free software; you can redistribute it and/or modify
102it under the same terms as Perl itself, either Perl version 5.8.8 or,
103at your option, any later version of Perl 5 you may have available.
104
105When C client is used as a standalone library:
106
107This library is free software; you can redistribute it and/or modify
108it under the terms of the GNU Lesser General Public License as
109published by the Free Software Foundation; either version 2.1 of the
110License, or (at your option) any later version.
111
112This library is distributed in the hope that it will be useful, but
113WITHOUT ANY WARRANTY; without even the implied warranty of
114MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
115Lesser General Public License for more details.
Note: See TracBrowser for help on using the repository browser.