@mornya/vessel/template/README.md

Creates/publishes a Node.js module with no build configuration.

# {{PROJECT_NAME}}
![npm](https://img.shields.io/npm/v/{{PROJECT_NAME}})
![node](https://img.shields.io/node/v/{{PROJECT_NAME}})
![types](https://img.shields.io/npm/types/{{PROJECT_NAME}})
![downloads](https://img.shields.io/npm/dw/{{PROJECT_NAME}})
![license](https://img.shields.io/npm/l/{{PROJECT_NAME}})

{{PROJECT_DESC}}

> This project has been created by [Vessel CLI](https://www.npmjs.com/package/@mornya/vessel).
  For a simple and quick reference about it, click [here](https://mornya.github.io/documents/guide/vessel.md).

## About
프로젝트 개발에 사용되는 모듈들에 대해 집합적인 형태로 제공되는 패키지.

## Installation
해당 라이브러리를 사용 할 프로젝트에서는 아래와 같이 의존성 모듈로 설치한다.
```bash
$ npm install --save {{PROJECT_NAME}}
or
$ yarn add {{PROJECT_NAME}}
```

## Modules in the package
본 패키지에는 아래와 같은 모듈들을 포함한다.<br>
제공되는 모듈과 메소드 사용법 등은 코드 스니핏을 참고한다.

### Sample module
샘플 모듈은 다음과 같은 메소드들을 제공한다.

#### `Sample.initialize`
초기화 실행 메소드.
```
Sample.initialize();
```

## Installation for development
해당 라이브러리의 개발환경과 빌드/배포 진행 등을 위한 설정으로 아래와 같이 전역 CLI 모듈을 설치한다.
```bash
$ npm install -g @mornya/vessel @lintest/cli sonarqube-scanner
or
$ yarn global add @mornya/vessel @lintest/cli sonarqube-scanner
```

## Change Log
프로젝트 변경사항은 [CHANGELOG.md](CHANGELOG.md) 파일 참조.

## License
프로젝트 라이센스는 [LICENSE](LICENSE) 파일 참조.