Skip to content
This repository has been archived by the owner on Feb 7, 2023. It is now read-only.

expand the documentation with examples #145

Open
qwesda opened this issue Mar 12, 2018 · 4 comments
Open

expand the documentation with examples #145

qwesda opened this issue Mar 12, 2018 · 4 comments

Comments

@qwesda
Copy link

qwesda commented Mar 12, 2018

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
Copy link
Member

alippai commented Jun 3, 2018

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
Copy link

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
Copy link

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

@pwFoo
Copy link

pwFoo commented Aug 4, 2019

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.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants