Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Merge pull request #27 from spl/patch-1

Some grammar improvements
  • Loading branch information...
commit 4a68062f2d036abb6c861a642b7025c1b37e6cc0 2 parents 747e373 + cfb69c2
Vincent Hanquez authored

Showing 1 changed file with 9 additions and 11 deletions. Show diff stats Hide diff stats

  1. +9 11 README.md
20 README.md
Source Rendered
... ... @@ -1,15 +1,15 @@
1 1 CryptoHash
2 2 ==========
3 3
4   -hs-cryptohash provides lots of different secure digest algorithms, also
5   -called cryptohashes. It exposes every common hashes, but also some
6   -more exotic hashes, provides an extensive list of hashes available
7   -with a consistant API.
  4 +`hs-cryptohash` provides many different secure digest algorithms, also
  5 +called cryptographic hash functions or, simply, cryptohashes. The package
  6 +exports common hash functions, as well as some more exotic ones, and
  7 +provides a single API for them all.
8 8
9   -The general performance are comparable to the most optimised hashes
  9 +The general performance is comparable to the most optimised implementations
10 10 available.
11 11
12   -The complete list of supported hashes:
  12 +Here is the complete list of supported algorithms:
13 13
14 14 * MD2, MD4, MD5
15 15 * RIPEMD160
@@ -24,11 +24,9 @@ You can easily import any hash with the following:
24 24
25 25 import qualified Crypto.Hash.<HASH> as <Hash>
26 26
27   -suggestion: it's easier to import qualified since there's
28   -a collision with the init symbol, but for only importing
29   -the hash or hashlazy function there's no such need.
30   -
31   -Every hashes, exposes a very similar API.
  27 +We recommend using `import qualified` because the APIs are similar and
  28 +many of the modules reuse the same names. However, if you are ony using
  29 +one module, there is no need to qualify the names.
32 30
33 31 Incremental API
34 32 ---------------

0 comments on commit 4a68062

Please sign in to comment.
Something went wrong with that request. Please try again.