From a375f896214429f01d552502a69e889d1b1c00ee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ionic=C4=83=20Biz=C4=83u?= Date: Sat, 23 Dec 2017 20:55:42 +0200 Subject: [PATCH] Updated docs --- .gitignore | 2 ++ DOCUMENTATION.md | 2 +- README.md | 10 +++++++--- package-lock.json | 4 ++-- package.json | 2 +- 5 files changed, 13 insertions(+), 7 deletions(-) diff --git a/.gitignore b/.gitignore index 51409dc..af96bda 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,5 @@ *.log node_modules *.env +.DS_Store +package-lock.json diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index 5f2931f..ead0c38 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -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**: diff --git a/README.md b/README.md index 62493b1..955b2c7 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,11 @@ + [![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. @@ -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 @@ -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**: @@ -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` @@ -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 diff --git a/package-lock.json b/package-lock.json index 2767a3c..02df84b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "image-to-ascii", - "version": "3.0.9", + "version": "3.0.10", "lockfileVersion": 1, "requires": true, "dependencies": { @@ -267,7 +267,7 @@ "lru-cache": { "version": "4.1.1", "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-4.1.1.tgz", - "integrity": "sha512-q4spe4KTfsAS1SUHLO0wz8Qiyf1+vMIAgpRYioFYDMNqKfHQbg+AVDH3i4fvpl71/P1L0dBl+fQi+P37UYf0ew==", + "integrity": "sha1-Yi4y6CSItJJ5EUpPns9F581rulU=", "requires": { "pseudomap": "1.0.2", "yallist": "2.1.2" diff --git a/package.json b/package.json index 0b06746..22c7319 100644 --- a/package.json +++ b/package.json @@ -88,4 +88,4 @@ "bloggify.json", "bloggify/" ] -} \ No newline at end of file +}