move README into README.md and update content

This commit is contained in:
Vincent Hanquez 2011-08-14 08:17:21 +01:00
parent 1799f8bbd6
commit 99cf9b4592
3 changed files with 26 additions and 8 deletions

7
README
View file

@ -1,7 +0,0 @@
The hs-tls project aims to reimplement the full TLS protocol (formely known as SSL) in haskell.
The focus of the projects is to provide a safer implementation than the ones existing,
through more purity, more type-checking, and more units tests.
While the focus is to make it safer than other implementations, this current
implementation is *not* to be considered secure, since it doesn't fully
implement everything necessary (full certificate checking, protocol requirements, etc)

25
README.md Normal file
View file

@ -0,0 +1,25 @@
haskell TLS
===========
This library provide native Haskell TLS and SSL protocol implementation for server and client.
Description
-----------
This provides a high-level implementation of a sensitive security protocol,
eliminating a common set of security issues through the use of the advanced
type system, high level constructions and common Haskell features.
Only core protocol available here, have a look at the tls-extra package for
default ciphers, compressions and certificates functions.
Features
--------
* tiny code base (more than 20 times smaller than openSSL, and 10 times smaller than gnuTLS)
* permissive license: BSD3
* supported versions: SSL3, TLS1.0, TLS1.1.
* key exchange supported: only RSA.
* bulk algorithm supported: any stream or block ciphers.
* supported extensions: secure renegociation

View file

@ -24,7 +24,7 @@ Category: Network
stability: experimental
Cabal-Version: >=1.6
Homepage: http://github.com/vincenthz/hs-tls
data-files: README, TODO
data-files: README.md, TODO
Flag test
Description: Build unit test