= ssdeep

* ssdeep ruby bindings (http://redstack.net/ruby-ssdeep)

== DESCRIPTION:

This are simple binding for the ssdeep C library (http://ssdeep.sourceforge.net/)

== FEATURES/PROBLEMS:

* Bindings fo hash_filename(), hash_buffer() and fuzzy_compare() APIs

== SYNOPSIS:

  require 'ssdeep'
  # Fuzzy hash a buffer's content
  hash1 = Ssdeep.fuzzy_hash_buf("This string contains the data of first file :)")
  # Fuzzy hash the content of the file '/path/to/file'
  hash2 = Ssdeep.fuzzy_hash_filename("/path/to/file")
  # Compare the 2 hashes, a value between 0 (no match) and 100 (full match) is returned
  Ssdeep.fuzzy_compare(hash1, hash2)

== REQUIREMENTS:

* ssdeep library and headers

== INSTALL:

* sudo gem install ssdeep

== DEVELOPERS:

After checking out the source, run:

  $ rake compile

This task will compile the extension

== LICENSE:

(The GPL License)

Copyright (c) 2010 Raffaello Pelagalli

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
02111-1307, USA.