diff --git a/.eslintrc.yaml b/.eslintrc.yaml new file mode 100644 index 0000000..8e7a676 --- /dev/null +++ b/.eslintrc.yaml @@ -0,0 +1,8 @@ +env: + es6: true + browser: true + node: true +extends: 'eslint:recommended' +parserOptions: + ecmaVersion: 2015 + sourceType: module diff --git a/LICENSE b/LICENSE index ab60297..98727e0 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2018 +Copyright (c) 2018 Conduitry Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index ad409c3..152e53a 100644 --- a/README.md +++ b/README.md @@ -1 +1,24 @@ -# do-not-zip \ No newline at end of file +# do-not-zip + +Do not zip. Just store. + +## What + +Stick some text files into a zip file. Works on the server (Node.js) and on the client (JavaScript). Requires ES2015+. + +## Usage + +```javascript +const output = doNotZip([{ path: 'path/to/file1.txt', data: 'Hello' }, { path: 'another/file2.txt', data: 'World' }]); +// output will be a Buffer on the server and a Blob on the client +``` + +## Thanks + +https://github.com/mrananyan/ZipperJS and https://users.cs.jmu.edu/buchhofp/forensics/formats/pkzip.html + +## License + +Copyright (c) 2018 Conduitry + +- [MIT](LICENSE)