summaryrefslogtreecommitdiff
path: root/Data/BuiltIn/Libraries/md5.lua/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Data/BuiltIn/Libraries/md5.lua/README.md')
-rw-r--r--Data/BuiltIn/Libraries/md5.lua/README.md62
1 files changed, 62 insertions, 0 deletions
diff --git a/Data/BuiltIn/Libraries/md5.lua/README.md b/Data/BuiltIn/Libraries/md5.lua/README.md
new file mode 100644
index 0000000..ee7bbd8
--- /dev/null
+++ b/Data/BuiltIn/Libraries/md5.lua/README.md
@@ -0,0 +1,62 @@
+md5.lua [![Build Status](https://travis-ci.org/kikito/md5.lua.svg)](https://travis-ci.org/kikito/md5.lua)
+=========================================================================================================
+
+This pure-Lua module computes md5 in Lua 5.1, Lua 5.2 and LuaJIT, using native bit-manipulation libraries when available, and falling back to table-based manipulation of integers in 5.1.
+
+It implements md5.sum and md5.sumhex like the [kernel project md5 package](http://www.keplerproject.org/md5/), but it's done completely in Lua, with no dependencies on other libs or C files.
+
+Usage
+=====
+
+Simple example:
+
+ local md5 = require 'md5'
+
+ local md5_as_data = md5.sum(message) -- returns raw bytes
+ local md5_as_hex = md5.sumhexa(message) -- returns a hex string
+ local md5_as_hex2 = md5.tohex(md5_as_data) -- returns the same string as md5_as_hex
+
+Incremental example (for computing md5 of streams, or big files which have to be loaded in chunks - new since 1.1.0):
+
+ local m = md5.new()
+ m:update('some bytes')
+ m:update('some more bytes')
+ m:update('etc')
+ return md5.tohex(m:finish())
+
+Credits
+=======
+
+This is a cleanup of an implementation by Adam Baldwin - https://gist.github.com/evilpacket/3647908
+
+Which in turn was a mix of the bitwise lib, http://luaforge.net/projects/bit/ by hanzhao (`abrash_han - at - hotmail.com`),
+and http://equi4.com/md5/md5calc.lua, by Equi 4 Software.
+
+Lua 5.2 and LuaJIT compatibility by [Positive07](https://github.com/kikito/md5.lua/pull/2)
+
+A very important fix and the incremental variant by [pgimeno](https://github.com/kikito/md5.lua/pull/10)
+
+
+License
+=======
+
+This library, as well as all the previous ones in which is based, is released under the MIT license (See license file for details).
+
+Specs
+=====
+
+The specs for this library are implemented with [busted](http://ovinelabs.com/busted/). In order to run them, install busted and then:
+
+ cd path/to/where/the/spec/folder/is
+ busted
+
+Install
+=======
+
+Either copy the file or using luarocks:
+
+ luarocks install --server=http://luarocks.org/manifests/kikito md5
+
+
+
+