# @getstation/logo-generator

> ## Getting Started

Latest version **0.3.2** (published 2018-06-05) · ISC license · 0 weekly downloads

## Install

```sh
npm install @getstation/logo-generator
pnpm add @getstation/logo-generator
yarn add @getstation/logo-generator
bun add @getstation/logo-generator
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.2 |
| Published | 2018-06-05 |
| First published | 2018-01-24 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 62.7 KB |
| Known vulnerabilities | 0 (+25 in 2 direct dependencies) |
| Install scripts | no |
| Maintainers | alexstrat, hugomano, magne4000, mathieudebit |

## Links

- npm: https://www.npmjs.com/package/@getstation/logo-generator
- npm.io page: https://npm.io/package/@getstation/logo-generator

## Dependencies (9)

- [axios](https://npm.io/package/axios.md) ^0.18.0
- [is-url](https://npm.io/package/is-url.md) ^1.2.2
- [cheerio](https://npm.io/package/cheerio.md) ^1.0.0-rc.2
- [potrace](https://npm.io/package/potrace.md) ^2.1.1
- [ts-node](https://npm.io/package/ts-node.md) ^4.1.0
- [csv-parse](https://npm.io/package/csv-parse.md) ^2.0.0
- [typescript](https://npm.io/package/typescript.md) ^2.6.2
- [commandpost](https://npm.io/package/commandpost.md) ^1.3.0
- [node-vibrant](https://npm.io/package/node-vibrant.md) ^3.0.0

## Recent versions

- 0.3.2 (latest) — 2018-06-05
- 0.3.1 — 2018-01-30
- 0.3.0 — 2018-01-30
- 0.2.0 — 2018-01-24
- 0.1.0 — 2018-01-24

## README

# logo-generator

## Getting Started

```
git clone git@github.com:getstation/logo-generator.git
cd logo-generator
yarn install
```

## Usage


### Options

Option              |	Description	
--------------------|---------------------------------------------------------------
`-data`             |	path to a CSV file (default is `./data.csv`)
`-name`             |	name of the exported SVG
`-url`              |	URL of the PNG logo (support local and online files)
`-clearbit`         |	param for the Clearbit logo API
`-color`            |	background color of the logo (HTML compliant)

You can either pass a logo with `-url` or `-clearbit`.
 > See the Clearbit logo API: https://clearbit.com/logo.
 
You can also pass a CSV file which contains rows of `name`, `url` and `color`.

## Examples

```
node lib/cli.js -color 'purple' -clearbit 'datadog.com' -name 'logo-datadog'
node lib/cli.js -color '#1F4087' -url './logo-atlassian.png'
node lib/cli.js -data
```

Everything will be exported in the `exports/` folder.

## Todo
- [ ] Be able to pass an SVG logo directly (and minify into a single path)
- [ ] Handle complex PNG files with multiple colors and gradients/opacity

---
_Source: https://npm.io/package/@getstation/logo-generator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._