Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
IonicaBizau committed Aug 9, 2020
1 parent ff9b033 commit 2fa18b7
Show file tree
Hide file tree
Showing 3 changed files with 137 additions and 39 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ node_modules
*.env
.DS_Store
package-lock.json
.bloggify/*
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2014-19 Ionică Bizău <bizauionica@gmail.com> (https://ionicabizau.net)
Copyright (c) 2014-20 Ionică Bizău <bizauionica@gmail.com> (https://ionicabizau.net)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
173 changes: 135 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,56 @@
<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->








[![image-to-ascii](http://i.imgur.com/pKydY5P.png)](#)











# image-to-ascii

[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/image-to-ascii.svg)](https://www.npmjs.com/package/image-to-ascii) [![Downloads](https://img.shields.io/npm/dt/image-to-ascii.svg)](https://www.npmjs.com/package/image-to-ascii) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)

<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>







> A Node.JS module that converts images to ASCII art.










[![image-to-ascii](http://i.imgur.com/Om8G7dZ.png)](#)







## :cloud: Installation

```sh
Expand All @@ -26,8 +64,20 @@ yarn add image-to-ascii

:bulb: **ProTip**: You can install the [cli version of this module](https://github.com/IonicaBizau/image-to-ascii-cli) by running `npm install --global image-to-ascii-cli` (or `yarn global add image-to-ascii-cli`).







Check out the [INSTALLATION.md](INSTALLATION.md) guide for more information.







## :clipboard: Example


Expand All @@ -51,6 +101,10 @@ imageToAscii("https://octodex.github.com/images/privateinvestocat.jpg", {







In order to run the `webcam.sh` provided in the `example` folder, you will also need streamer. The script uses streamer to make webcam pictures and converts them into ASCII art using the `webcam.js`

```sh
Expand All @@ -70,17 +124,24 @@ sh webcam.sh







## :question: Get Help

There are few ways to get help:



1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:

3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:





## :memo: Documentation


Expand Down Expand Up @@ -146,12 +207,22 @@ Converts the provided image in ASCII art.














## :yum: How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].


## :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).

Expand All @@ -170,56 +241,82 @@ However, if you get some profit from this or just want to encourage me to contin
Thanks! :heart:
















## :dizzy: Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles:

- `gif-cli`
- `aceituna`
- `gongxi`
- `noslide-js`
- `sprite-cli-js`
- `terminal-sidecar`
- `@radic/cli`
- `tmuxos`
- `ascii-github`
- `alphabet-cli`
- `nrk-tv-cli`
- `kayak-inside`
- `nobro`
- `goteem`
- `imgurize`
- `doomjs`
- `image-to-js`
- `salestock-cli`
- `joctodex`
- `path-cli`
- `ascii-video`
- `js2image`
- `moltres-cli`
- `image-to-ascii-cli`
- `img-to-svg`
- `mdy`
- `node.cobol`
- `bing-cli`
- `ick`
- `cli-emoji`
- `cli-github`










- [`aceituna`](https://github.com/davepgreene/aceituna#readme) (by Dave Greene)—Drool worthy
- [`alphabet-cli`](https://github.com/joliveros/alphabet-cli#readme)—undefined
- [`ascii-github`](https://npmjs.com/package/ascii-github)—GitHub CLI Client
- [`ascii-video`](https://github.com/fossage/ASCII-Video#readme) (by Justin Foss)—A tool to create and play sprite animation in the terminal
- [`bing-cli`](https://github.com/scottbea/bing-cli#readme) (by Scott Beaudreau)—Use Bing Search in the terminal via command line
- [`cli-emoji`](https://github.com/IonicaBizau/cli-emoji#readme)—Big emojis in your terminal.
- [`cli-github`](https://github.com/IonicaBizau/cli-github)—A fancy GitHub client for command line.
- [`doomjs`](https://github.com/codezilla-it/doom#readme) (by Fabio Cencetti)—A bunch of modular gulp tasks
- [`gif-cli`](https://github.com/IonicaBizau/gif-cli)—Gif animations in your terminal!
- [`gongxi`](https://github.com/clonn/gongxi) (by clonn)—恭喜系列 cli
- [`goteem`](https://npmjs.com/package/goteem) (by Austin Kelleher, a@alk.im)—goteem
- [`ick`](https://github.com/nteract/ick#readme) (by Kyle Kelley)—Interactive Console Experiment
- [`image-to-ascii-cli`](https://github.com/IonicaBizau/image-to-ascii-cli#readme)—View images in text format, in your terminal.
- [`image-to-js`](https://github.com/xinyu198736/image-to-js#readme) (by yutou)—用js代码和图片,生成一段可以正常运行的图形化的js源代码
- [`img-to-svg`](https://github.com/IonicaBizau/img-to-svg#readme)—Convert the image pixels in SVG squares.
- [`imgurize`](https://github.com/mkaminsky11/imgurize) (by Michael Kaminsky)—an Imgur browser in the terminal
- [`joctodex`](https://github.com/IonicaBizau/joctodex#readme)—Octocats in terminal!
- [`js2image`](https://github.com/xinyu198736/image-to-js#readme) (by yutou)—用js代码和图片,生成一段可以正常运行的图形化的js源代码
- [`kayak-inside`](https://github.com/stewartulm/inside#readme) (by Stewart Ulm)—Team Directory
- [`mdy`](https://github.com/IonicaBizau/mdy#readme)—View markdown files in the command line with ANSI styled images.
- [`moltres-cli`](https://github.com/brianneisler/moltres/tree/master/cli#readme) (by Brian Neisler)—CLI for the Moltres CMS for Firebase
- [`nobro`](https://github.com/marsch/nodarkside#readme) (by Mario Scheliga)—Prevent brothers and sisters from falling to the dark side by robbing their npm-workflow virginity
- [`node.cobol`](https://github.com/IonicaBizau/node.cobol#readme)—Node.js bridge for COBOL which allows you to run Node.js code from COBOL.
- [`noslide-js`](https://github.com/crazyguitar/noslide.js#readme) (by fly)—A Simple Terminal slide tool
- [`nrk-tv-cli`](https://github.com/Starefossen/nrk-tv-cli#readme) (by Hans Kristian Flaatten)—Command line client for interacting with TV programs from the Norwegian Broadcasting Corporation (NRK)
- [`path-cli`](https://npmjs.com/package/path-cli) (by Muhammad Mustadi)—[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
- [`salestock-cli`](https://npmjs.com/package/salestock-cli) (by Muhammad Mustadi)—salestock CLI app
- [`sprite-cli-js`](https://npmjs.com/package/sprite-cli-js) (by Justin Foss)—
- [`terminal-sidecar`](https://npmjs.com/package/terminal-sidecar) (by Kyle Kelley)—Jupyter sidecar in your terminal
- [`tmuxos`](https://github.com/TmuxOS/TmuxOS)—The awesome power of command line is finally revealed.

## :scroll: License

[MIT][license] © [Ionică Bizău][website]






[license]: /LICENSE
[website]: https://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg

[patreon]: https://www.patreon.com/ionicabizau
[amazon]: http://amzn.eu/hRo9sIZ
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW

[license]: http://showalicense.com/?fullname=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica%40gmail.com%3E%20(https%3A%2F%2Fionicabizau.net)&year=2014#license-mit
[website]: https://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md

0 comments on commit 2fa18b7

Please sign in to comment.