Skip to content

Commit 1c0ff13

Browse files
committed
Updated docs
1 parent 09207c6 commit 1c0ff13

File tree

3 files changed

+21
-9
lines changed

3 files changed

+21
-9
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,6 @@
33
*~
44
*.log
55
node_modules
6+
*.env
7+
.DS_Store
8+
package-lock.json

DOCUMENTATION.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ You can see below the API reference of this module.
66
Converts the provided image in ASCII art.
77

88
#### Params
9+
910
- **String** `source`: The path/url to the image.
1011
- **Object|String** `options`: The path to the image or an object containing the following fields:
1112

README.md

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

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

46
# image-to-ascii
57

6-
[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![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)
8+
[![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)
79

810
> A Node.JS module that converts images to ASCII art.
911
@@ -41,14 +43,6 @@ imageToAscii("https://octodex.github.com/images/privateinvestocat.jpg", {
4143
});
4244
```
4345

44-
## :question: Get Help
45-
46-
There are few ways to get help:
47-
48-
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.
49-
2. For bug reports and feature requests, open issues. :bug:
50-
3. For direct and quick help from me, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
51-
5246

5347

5448
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`
@@ -64,13 +58,24 @@ To run the script just use:
6458
sh webcam.sh
6559
```
6660

61+
62+
## :question: Get Help
63+
64+
There are few ways to get help:
65+
66+
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.
67+
2. For bug reports and feature requests, open issues. :bug:
68+
3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
69+
70+
6771
## :memo: Documentation
6872

6973

7074
### `imageToAscii(source, options, callback)`
7175
Converts the provided image in ASCII art.
7276

7377
#### Params
78+
7479
- **String** `source`: The path/url to the image.
7580
- **Object|String** `options`: The path to the image or an object containing the following fields:
7681

@@ -140,6 +145,7 @@ this takes time. You can integrate and use these projects in your applications *
140145
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:
141146

142147
- Starring and sharing the projects you like :rocket:
148+
- [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
143149
- [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
144150
- [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
145151
- **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6`
@@ -156,6 +162,7 @@ If you are using this library in one of your projects, add it in this list. :spa
156162
- [`aceituna`](https://github.com/davepgreene/aceituna#readme) (by Dave Greene)—Drool worthy
157163
- [`alphabet-cli`](https://github.com/joliveros/alphabet-cli#readme)—undefined
158164
- [`ascii-github`](https://npmjs.com/package/ascii-github)—GitHub CLI Client
165+
- [`ascii-video`](https://github.com/fossage/ASCII-Video#readme) (by Justin Foss)—A tool to create and play sprite animation in the terminal
159166
- [`bing-cli`](https://github.com/scottbea/bing-cli#readme) (by Scott Beaudreau)—Use Bing Search in the terminal via command line
160167
- [`bronos`](https://github.com/kswilster/bronos#readme) (by Keith Williams)—A sonos cli for bros
161168
- [`cli-emoji`](https://github.com/IonicaBizau/cli-emoji#readme)—Big emojis in your terminal.
@@ -180,6 +187,7 @@ If you are using this library in one of your projects, add it in this list. :spa
180187
- [`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)
181188
- [`protractor-screenshoter-plugin`](https://github.com/azachar/protractor-screenshoter-plugin) (by Andrej Zachar)—A jasmine2 protractor plugin that captures for each browser instance a screenshot and browsers' console logs. The snapshot is made optionally for each expect or spec. Plugins comes with a beautiful angular based analytics tool to visually check and fix te
182189
- [`salestock-cli`](https://npmjs.com/package/salestock-cli) (by Muhammad Mustadi)—salestock CLI app
190+
- [`sprite-cli-js`](https://npmjs.com/package/sprite-cli-js) (by Justin Foss)—
183191
- [`terminal-sidecar`](https://npmjs.com/package/terminal-sidecar) (by Kyle Kelley)—Jupyter sidecar in your terminal
184192
- [`tmuxos`](https://github.com/TmuxOS/TmuxOS)—The awesome power of command line is finally revealed.
185193

0 commit comments

Comments
 (0)