Skip to content

Commit

Permalink
fixing up the README.txt
Browse files Browse the repository at this point in the history
  • Loading branch information
jmhodges committed May 4, 2009
1 parent 2c656ad commit a8af0c5
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions README.txt
Original file line number Diff line number Diff line change
@@ -1,32 +1,38 @@
= minhash

* FIX (url)
* http://example.com

== DESCRIPTION:

FIX (describe your package)
Runs the MinHash algo across some strings using the murmur hash
function.

== FEATURES/PROBLEMS:

* FIX (list of features or problems)
* Does it right.

== SYNOPSIS:
* Only works well for datasets with fewer than 2**32 (~4 billion)
unique items in it. Larger than that and, due to use our hash
function using unsigned 64-bit integers, we run into the birthday
paradox.

FIX (code sample of usage)
== SYNOPSIS:
# 23 can be any unsigned 32-bit integer, a la the MurmurHash docs.
MinHash.minhash(['a', 'foo', 'c'], 23)

== REQUIREMENTS:

* FIX (list of requirements)
* murmur_hash gem

== INSTALL:

* FIX (sudo gem install, anything else)
* sudo gem install minhash

== LICENSE:

(The MIT License)

Copyright (c) 2009 FIX
Copyright (c) 2009 Jeff Hodges

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
Expand Down

0 comments on commit a8af0c5

Please sign in to comment.