asmcrypto / asmcrypto.js

JavaScript Cryptographic Library with performance in mind.
MIT License
659 stars 182 forks source link

expand the documentation with examples #145

Open qwesda opened 6 years ago

qwesda commented 6 years ago

I was trying to figure out how to hash a file in the browser. Unfortunately the documentation wasn't a big help and I had to dig around in the issues (namely #55 and #119) and in the source.

It would be nice to have some examples to consult. I can provide the solution I ended up with for hashing a large file in chunks hash_large_file.html.

The code is no-frills vanilla JS and I hope it is easy to understand, self explanatory, and doesn't contain an embarrassing bug.

alippai commented 6 years ago

I hope, the new 2.0 version with TypeScript is easier to read. I want to add some docs to the new API later.

mesqueeb commented 5 years ago

I wanted to ask exactly this. I want to be able to do something like this in my app:

// prepare data to save on server
const dataToServer = encrypt('some string', secret) // with a secret
// after retrieving data from server
const dataFromServer = decrypt(data, secret)
hasufell commented 5 years ago

this library has zero documentation, what's the status?

pwFoo commented 4 years ago

How to use with client browser and for example key generation (example with external and compatible JS tool) and some more examples for sign / verify, encrypt / decrypt? Or a demo to see how it works and take a look in the source code.