zip-build/README.md

Node package to zip your build directory and name it according to your package.json name and version.

<h1 align="center">Welcome to zip-build 👋</h1>
<p align="center">
  <a href="https://www.npmjs.com/package/zip-build" target="_blank">
    <img alt="Version" src="https://img.shields.io/npm/v/zip-build.svg?logo=npm&style=flat-square">
    <img alt="Downloads" src="https://img.shields.io/npm/dt/zip-build?style=flat-square">
  </a>
</p>
<p align="center">
  <a href="https://github.com/tribal2/zip-build#readme" target="_blank">
    <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg?logo=github&style=flat-square" />
  </a>
  <a href="https://github.com/tribal2/zip-build/graphs/commit-activity" target="_blank">
    <img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg?style=flat-square" />
  </a>
  <a href="https://github.com/tribal2/zip-build/blob/master/LICENSE" target="_blank">
    <img alt="License: MIT" src="https://img.shields.io/github/license/tribal2/zip-build?style=flat-square" />
  </a>
</p>

> Node package to zip your build directory and name it according to your package.json name and version.

## Install

```sh
$ npm install --save-dev zip-build
```

## Usage

```sh
$ zip-build --help

# Usage: zip-build <build-dir> <zip-dir> [options]
#
# Positionals:
#   buildDir  Directory of your build output                    [default: "build"]
#   zipDir    Directory for your zipped backup                   [default: "dist"]
#
# Options:
#       --version      Show version number                               [boolean]
#   -h, --help         Show help                                         [boolean]
#   -i, --interactive  Enable interactive mode          [boolean] [default: false]
#   -f, --format       Format of output file
#                                [string] [choices: "zip", "tar"] [default: "zip"]
#   -n, --name         Ask for output archive filename (requires flag
#                      --interactive)                   [boolean] [default: false]
#   -t, --template     Template for output archive filename
#                         [string] [default: "%NAME%_%VERSION%_%TIMESTAMP%.%EXT%"]
#   -s, --subDir       Creates a sub directory to put all files
#                                                           [string] [default: ""]
#   -o, --override     Override the output file if it already exists
#                                                       [boolean] [default: false]
#
# Examples:
#   zip-build                    Zip <build> directory and put archive under
#                                <dist> directory.
#   zip-build out backup         Zip <out> directory and put archive under
#                                <backup> directory.
#   zip-build out backup -f tar  Archive <out> directory and put archive under
#                                <backup> directory compressed with Tar.
```

Include it as part of your npm build workflow:
```javascript
//package.json
  {
    "name": "your-project",
    // ...
    "scripts": {
      // ...
      "build": "build && zip-build",
      // ...
    },
    // ...
  }
```

## CONTRIBUTING

- Use [Conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) specification for your commit messages.
- Write test for your changes and make sure they pass before opening a PR.
- Open your PR against the **base:develop branch**.

## Author

👤 **Ricardo Tribaldos (https://barustudio.com)**

<a href="https://github.com/tribal2" target="_blank">
  <img alt="Github: tribal2" src="https://img.shields.io/github/followers/tribal2?label=%20%40tribal2&style=social" />
</a>

<a href="https://twitter.com/r_tribaldos" target="_blank">
  <img alt="Twitter: r\_tribaldos" src="https://img.shields.io/twitter/follow/r_tribaldos?label=%40r_tribaldos&style=social" />
</a>

<a href="https://linkedin.com/in/rtribaldos" target="_blank">
  <img alt="Linkedin: rtribaldos" src="https://img.shields.io/badge/%40rtribaldos-500+-blue?style=social&logo=linkedin" />
</a>

## Show your support

Give a ⭐️ if this project helped you!

## 📝 License

Copyright © 2020 [Ricardo Tribaldos (https://barustudio.com)](https://github.com/tribal2).<br />
This project is [MIT](https://github.com/tribal2/zip-build/blob/master/LICENSE) licensed.

***
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_