/
README.txt
1 = ssdeep
2
3 * ssdeep ruby bindings (http://redstack.net/ruby-ssdeep)
4
5 == DESCRIPTION:
6
7 This are simple binding for the ssdeep C library (http://ssdeep.sourceforge.net/)
8
9 == FEATURES/PROBLEMS:
10
11 * Bindings fo hash_filename(), hash_buffer() and fuzzy_compare() APIs
12
13 == SYNOPSIS:
14
15 require 'ssdeep'
16 # Fuzzy hash a buffer's content
17 hash1 = Ssdeep.fuzzy_hash_buf("This string contains the data of first file :)")
18 # Fuzzy hash the content of the file '/path/to/file'
19 hash2 = Ssdeep.fuzzy_hash_filename("/path/to/file")
20 # Compare the 2 hashes, a value between 0 (no match) and 100 (full match) is returned
21 Ssdeep.fuzzy_compare(hash1, hash2)
22
23 == REQUIREMENTS:
24
25 * ssdeep library and headers
26
27 == INSTALL:
28
29 * sudo gem install ssdeep
30
31 == DEVELOPERS:
32
33 After checking out the source, run:
34
35 $ rake compile
36
37 This task will compile the extension
38
39 == LICENSE:
40
41 (The GPL License)
42
43 Copyright (c) 2010 Raffaello Pelagalli
44
45 This program is free software; you can redistribute it and/or
46 modify it under the terms of the GNU General Public License
47 as published by the Free Software Foundation; either version 2
48 of the License, or (at your option) any later version.
49
50 This program is distributed in the hope that it will be useful,
51 but WITHOUT ANY WARRANTY; without even the implied warranty of
52 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
53 GNU General Public License for more details.
54
55 You should have received a copy of the GNU General Public License
56 along with this program; if not, write to the Free Software
57 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
58 02111-1307, USA.
59