minor corrections and improvements to README

he32 · May 2, 2011 · c4ea9a0 · c4ea9a0
1 parent ddef138
commit c4ea9a0
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/NEWS b/NEWS
@@ -1,6 +1,6 @@
 CityHash vXXX, DATE
 
-  * Fixed a typo in README
+  * Minor corrections and improvements to README.
 
 CityHash v1.0.1, April 28, 2011
 

diff --git a/README b/README
@@ -108,15 +108,15 @@ Usage
 
 The above installation instructions will produce a single library.  It will
 contain CityHash64() and CityHash128() and their variants, and possibly
-CityHashCrc128() and CityHashCrc128WithSeed().  The functions with Crc in
-the name are declared in citycrc.h; the rest are declared in city.h.
+CityHashCrc128(), CityHashCrc128WithSeed(), and CityHashCrc256().  The
+functions with Crc in the name are declared in citycrc.h; the rest are
+declared in city.h.
 
 
 Limitations
 ===========
 
-1) The current version of CityHash is intended for little-endian 64-bit
-CPUs.
+1) The current version of CityHash is intended for little-endian 64-bit CPUs.
 
 Functions that do use the CRC32 instruction should also work, slowly, in
 little-endian 32-bit code.  CityHash should work on big-endian CPUs as well;
@@ -146,8 +146,8 @@ The CityHash functions have the following flaws according to SMHasher:
 (1) CityHash64: some cases of poor avalanching, which we suspect don't matter in
 practice, with some inputs <= 16 bytes.
 
-(2) CityHash64WithSeed: one or two minor issues with inputs of at most two
-non-zeroes and length <= 24 bytes.
+(2) CityHash64WithSeed: one or two minor issues with inputs containing at most
+two non-zero bytes and length <= 24 bytes.
 
 (3) CityHash64WithSeeds: did not test