Skip to content

Commit a375f89

Browse files
committed
Updated docs
1 parent a33dbd1 commit a375f89

File tree

5 files changed

+13
-7
lines changed

5 files changed

+13
-7
lines changed

.gitignore

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

DOCUMENTATION.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Converts the provided image in ASCII art.
77

88
#### Params
99

10-
- **String** `source`: The path/url to the image.
10+
- **String|Buffer** `source`: The path/url to the image or a Buffer object.
1111
- **Object|String** `options`: The path to the image or an object containing the following fields:
1212

1313
**Size Options**:

README.md

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

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

56
# image-to-ascii
67

7-
[![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)
89

910
> A Node.JS module that converts images to ASCII art.
1011
@@ -69,9 +70,11 @@ There are few ways to get help:
6970

7071
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.
7172
2. For bug reports and feature requests, open issues. :bug:
73+
7274
3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
7375

7476

77+
7578
## :memo: Documentation
7679

7780

@@ -80,7 +83,7 @@ Converts the provided image in ASCII art.
8083

8184
#### Params
8285

83-
- **String|Buffer** `source`: The path/url to the image or a `Buffer` object.
86+
- **String|Buffer** `source`: The path/url to the image or a Buffer object.
8487
- **Object|String** `options`: The path to the image or an object containing the following fields:
8588

8689
**Size Options**:
@@ -149,6 +152,7 @@ this takes time. You can integrate and use these projects in your applications *
149152
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:
150153

151154
- Starring and sharing the projects you like :rocket:
155+
- [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
152156
- [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
153157
- [![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).
154158
- **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6`
@@ -167,7 +171,7 @@ If you are using this library in one of your projects, add it in this list. :spa
167171
- [`ascii-github`](https://npmjs.com/package/ascii-github)—GitHub CLI Client
168172
- [`ascii-video`](https://github.com/fossage/ASCII-Video#readme) (by Justin Foss)—A tool to create and play sprite animation in the terminal
169173
- [`bing-cli`](https://github.com/scottbea/bing-cli#readme) (by Scott Beaudreau)—Use Bing Search in the terminal via command line
170-
- [`bronos`](https://github.com/kswilster/bronos#readme) (by Keith Williams)—A sonos cli for bros
174+
- [`bronos`](https://npmjs.com/package/bronos) (by Keith Williams)—A sonos cli for bros
171175
- [`cli-emoji`](https://github.com/IonicaBizau/cli-emoji#readme)—Big emojis in your terminal.
172176
- [`cli-github`](https://github.com/IonicaBizau/cli-github)—A fancy GitHub client for command line.
173177
- [`doomjs`](https://github.com/codezilla-it/doom#readme) (by Fabio Cencetti)—A bunch of modular gulp tasks

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,4 +88,4 @@
8888
"bloggify.json",
8989
"bloggify/"
9090
]
91-
}
91+
}

0 commit comments

Comments
 (0)