Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
IonicaBizau committed Dec 23, 2017
1 parent a33dbd1 commit a375f89
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 7 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,5 @@
*.log
node_modules
*.env
.DS_Store
package-lock.json
2 changes: 1 addition & 1 deletion DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Converts the provided image in ASCII art.

#### Params

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

**Size Options**:
Expand Down
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
<!-- 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] [![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)
[![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)

> A Node.JS module that converts images to ASCII art.
Expand Down Expand Up @@ -69,9 +70,11 @@ 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 All @@ -80,7 +83,7 @@ Converts the provided image in ASCII art.

#### Params

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

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

- Starring and sharing the projects you like :rocket:
- [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
- [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
- [![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).
- **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6`
Expand All @@ -167,7 +171,7 @@ If you are using this library in one of your projects, add it in this list. :spa
- [`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
- [`bronos`](https://github.com/kswilster/bronos#readme) (by Keith Williams)—A sonos cli for bros
- [`bronos`](https://npmjs.com/package/bronos) (by Keith Williams)—A sonos cli for bros
- [`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
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -88,4 +88,4 @@
"bloggify.json",
"bloggify/"
]
}
}

0 comments on commit a375f89

Please sign in to comment.