Home

Awesome

<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->

$ image-to-ascii

Support me on Patreon Buy me a book PayPal Ask me anything Version Downloads Get help on Codementor

<a href="https://www.buymeacoffee.com/H96WwChMy" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee"></a>

View images in text format, in your terminal.

:cloud: Installation

You can install the package globally and use it as command line tool:

# Using npm
npm install --global image-to-ascii-cli

# Using yarn
yarn global add image-to-ascii-cli

:bulb: ProTip: If you want to use this package as module, check out image-to-ascii—the API version of it.

Then, run image-to-ascii --help and see what the CLI tool can do.

$ image-to-ascii --help
Usage: image-to-ascii-cli [options]

Options:
  -i, --img <path>  Image path
  -h, --help        Displays this help.
  -v, --version     Displays version information.

Examples:
  image-to-ascii -i path/to/some/image.png


:memo: Documentation

For full API reference, see the DOCUMENTATION.md file.

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

Thanks! :heart:

:scroll: License

MIT © Ionică Bizău