Browse Source

docs and stuff

pull/1/head
Conduitry 2 years ago
parent
commit
f2f80904fd
3 changed files with 33 additions and 2 deletions
  1. +8
    -0
      .eslintrc.yaml
  2. +1
    -1
      LICENSE
  3. +24
    -1
      README.md

+ 8
- 0
.eslintrc.yaml View File

@ -0,0 +1,8 @@
env:
es6: true
browser: true
node: true
extends: 'eslint:recommended'
parserOptions:
ecmaVersion: 2015
sourceType: module

+ 1
- 1
LICENSE View File

@ -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

+ 24
- 1
README.md View File

@ -1 +1,24 @@
# do-not-zip
# 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)

Loading…
Cancel
Save