Skip to content

Commit 2fa18b7

Browse files
committed
Updated docs
1 parent ff9b033 commit 2fa18b7

File tree

3 files changed

+137
-39
lines changed

3 files changed

+137
-39
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@ node_modules
66
*.env
77
.DS_Store
88
package-lock.json
9+
.bloggify/*

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2014-19 Ionică Bizău <[email protected]> (https://ionicabizau.net)
3+
Copyright (c) 2014-20 Ionică Bizău <[email protected]> (https://ionicabizau.net)
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 135 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,56 @@
11
<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->
22

33

4+
5+
6+
7+
8+
9+
410
[![image-to-ascii](http://i.imgur.com/pKydY5P.png)](#)
511

12+
13+
14+
15+
16+
17+
18+
19+
20+
21+
622
# image-to-ascii
723

824
[![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)
925

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

28+
29+
30+
31+
32+
33+
1234
> A Node.JS module that converts images to ASCII art.
1335
36+
37+
38+
39+
40+
41+
42+
43+
44+
45+
1446
[![image-to-ascii](http://i.imgur.com/Om8G7dZ.png)](#)
1547

48+
49+
50+
51+
52+
53+
1654
## :cloud: Installation
1755

1856
```sh
@@ -26,8 +64,20 @@ yarn add image-to-ascii
2664

2765
: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`).
2866

67+
68+
69+
70+
71+
72+
2973
Check out the [INSTALLATION.md](INSTALLATION.md) guide for more information.
3074

75+
76+
77+
78+
79+
80+
3181
## :clipboard: Example
3282

3383

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

52102

53103

104+
105+
106+
107+
54108
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`
55109

56110
```sh
@@ -70,17 +124,24 @@ sh webcam.sh
70124

71125

72126

127+
128+
129+
130+
73131
## :question: Get Help
74132

75133
There are few ways to get help:
76134

135+
136+
77137
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.
78138
2. For bug reports and feature requests, open issues. :bug:
79-
80139
3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
81140

82141

83142

143+
144+
84145
## :memo: Documentation
85146

86147

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

147208

148209

210+
211+
212+
213+
214+
215+
216+
217+
218+
219+
220+
149221
## :yum: How to contribute
150222
Have an idea? Found a bug? See [how to contribute][contributing].
151223

152224

153225
## :sparkling_heart: Support my projects
154-
155226
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
156227
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).
157228

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

172243

244+
245+
246+
247+
248+
249+
250+
251+
252+
253+
254+
255+
256+
257+
173258
## :dizzy: Where is this library used?
174259
If you are using this library in one of your projects, add it in this list. :sparkles:
175260

261+
- `gif-cli`
262+
- `aceituna`
263+
- `gongxi`
264+
- `noslide-js`
265+
- `sprite-cli-js`
266+
- `terminal-sidecar`
267+
- `@radic/cli`
268+
- `tmuxos`
269+
- `ascii-github`
270+
- `alphabet-cli`
271+
- `nrk-tv-cli`
272+
- `kayak-inside`
273+
- `nobro`
274+
- `goteem`
275+
- `imgurize`
276+
- `doomjs`
277+
- `image-to-js`
278+
- `salestock-cli`
279+
- `joctodex`
280+
- `path-cli`
281+
- `ascii-video`
282+
- `js2image`
283+
- `moltres-cli`
284+
- `image-to-ascii-cli`
285+
- `img-to-svg`
286+
- `mdy`
287+
- `node.cobol`
288+
- `bing-cli`
289+
- `ick`
290+
- `cli-emoji`
291+
- `cli-github`
292+
293+
294+
295+
296+
297+
298+
299+
300+
176301

177-
- [`aceituna`](https://github.com/davepgreene/aceituna#readme) (by Dave Greene)—Drool worthy
178-
- [`alphabet-cli`](https://github.com/joliveros/alphabet-cli#readme)—undefined
179-
- [`ascii-github`](https://npmjs.com/package/ascii-github)—GitHub CLI Client
180-
- [`ascii-video`](https://github.com/fossage/ASCII-Video#readme) (by Justin Foss)—A tool to create and play sprite animation in the terminal
181-
- [`bing-cli`](https://github.com/scottbea/bing-cli#readme) (by Scott Beaudreau)—Use Bing Search in the terminal via command line
182-
- [`cli-emoji`](https://github.com/IonicaBizau/cli-emoji#readme)—Big emojis in your terminal.
183-
- [`cli-github`](https://github.com/IonicaBizau/cli-github)—A fancy GitHub client for command line.
184-
- [`doomjs`](https://github.com/codezilla-it/doom#readme) (by Fabio Cencetti)—A bunch of modular gulp tasks
185-
- [`gif-cli`](https://github.com/IonicaBizau/gif-cli)—Gif animations in your terminal!
186-
- [`gongxi`](https://github.com/clonn/gongxi) (by clonn)—恭喜系列 cli
187-
- [`goteem`](https://npmjs.com/package/goteem) (by Austin Kelleher, [email protected])—goteem
188-
- [`ick`](https://github.com/nteract/ick#readme) (by Kyle Kelley)—Interactive Console Experiment
189-
- [`image-to-ascii-cli`](https://github.com/IonicaBizau/image-to-ascii-cli#readme)—View images in text format, in your terminal.
190-
- [`image-to-js`](https://github.com/xinyu198736/image-to-js#readme) (by yutou)—用js代码和图片,生成一段可以正常运行的图形化的js源代码
191-
- [`img-to-svg`](https://github.com/IonicaBizau/img-to-svg#readme)—Convert the image pixels in SVG squares.
192-
- [`imgurize`](https://github.com/mkaminsky11/imgurize) (by Michael Kaminsky)—an Imgur browser in the terminal
193-
- [`joctodex`](https://github.com/IonicaBizau/joctodex#readme)—Octocats in terminal!
194-
- [`js2image`](https://github.com/xinyu198736/image-to-js#readme) (by yutou)—用js代码和图片,生成一段可以正常运行的图形化的js源代码
195-
- [`kayak-inside`](https://github.com/stewartulm/inside#readme) (by Stewart Ulm)—Team Directory
196-
- [`mdy`](https://github.com/IonicaBizau/mdy#readme)—View markdown files in the command line with ANSI styled images.
197-
- [`moltres-cli`](https://github.com/brianneisler/moltres/tree/master/cli#readme) (by Brian Neisler)—CLI for the Moltres CMS for Firebase
198-
- [`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
199-
- [`node.cobol`](https://github.com/IonicaBizau/node.cobol#readme)—Node.js bridge for COBOL which allows you to run Node.js code from COBOL.
200-
- [`noslide-js`](https://github.com/crazyguitar/noslide.js#readme) (by fly)—A Simple Terminal slide tool
201-
- [`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)
202-
- [`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)
203-
- [`salestock-cli`](https://npmjs.com/package/salestock-cli) (by Muhammad Mustadi)—salestock CLI app
204-
- [`sprite-cli-js`](https://npmjs.com/package/sprite-cli-js) (by Justin Foss)—
205-
- [`terminal-sidecar`](https://npmjs.com/package/terminal-sidecar) (by Kyle Kelley)—Jupyter sidecar in your terminal
206-
- [`tmuxos`](https://github.com/TmuxOS/TmuxOS)—The awesome power of command line is finally revealed.
207302

208303
## :scroll: License
209304

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

212307

308+
309+
310+
311+
312+
[license]: /LICENSE
313+
[website]: https://ionicabizau.net
314+
[contributing]: /CONTRIBUTING.md
315+
[docs]: /DOCUMENTATION.md
213316
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
214317
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
215318
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
216319
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
217-
218320
[patreon]: https://www.patreon.com/ionicabizau
219321
[amazon]: http://amzn.eu/hRo9sIZ
220322
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW
221-
222-
[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
223-
[website]: https://ionicabizau.net
224-
[contributing]: /CONTRIBUTING.md
225-
[docs]: /DOCUMENTATION.md

0 commit comments

Comments
 (0)