crop-github-images-cli/README.md

> Crop your images and gifs for your GitHub Profile!

# ✂️ `crop-github-images-cli`

> Crop your images and gifs for your GitHub Profile!

## Usage

```sh
$ npx crop-github-images-cli <path-to-image-or-gif> [--github-token|-t <Personal Access Token>]
```

From

![](gist.jpg)

To

![](result.png)

See examples for example results.

## Requirements

Node >= 8

`npm`/`npx`

## Auto Post to GitHub Gists

Supply a [Personal Access Token](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line) in `--github-token|-t` option to automatically create gists from the cropped asset.

## Notes

Images will be automatically resized to be 727xauto.

## How to pin them in Github

[Here](https://gist.github.com/gr2m/1a8af488e0c61bb627c24eecfd6148fd)

## Example

https://github.com/mathdroid

## Notes

Have fun!