draft: refactor project so it sits on top of a standalone app

2020-05-11 15:34:47 +02:00
parent a9ee5acc1c
commit f97e8455fc
13068 changed files with 1735502 additions and 866 deletions
@@ -0,0 +1,41 @@
+# buffer-xor
+
+[![TRAVIS](https://secure.travis-ci.org/crypto-browserify/buffer-xor.png)](http://travis-ci.org/crypto-browserify/buffer-xor)
+[![NPM](http://img.shields.io/npm/v/buffer-xor.svg)](https://www.npmjs.org/package/buffer-xor)
+
+[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
+
+A simple module for bitwise-xor on buffers.
+
+
+## Examples
+
+``` javascript
+var xor = require("buffer-xor")
+var a = new Buffer('00ff0f', 'hex')
+var b = new Buffer('f0f0', 'hex')
+
+console.log(xor(a, b))
+// => <Buffer f0 0f>
+```
+
+
+Or for those seeking those few extra cycles, perform the operation in place:
+
+``` javascript
+var xorInplace = require("buffer-xor/inplace")
+var a = new Buffer('00ff0f', 'hex')
+var b = new Buffer('f0f0', 'hex')
+
+console.log(xorInplace(a, b))
+// => <Buffer f0 0f>
+// NOTE: xorInplace will return the shorter slice of its parameters
+
+// See that a has been mutated
+console.log(a)
+// => <Buffer f0 0f 0f>
+```
+
+
+## License [MIT](LICENSE)
+