diff --git a/.gitignore b/.gitignore index 61f2900..af96bda 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,6 @@ *~ *.log node_modules +*.env +.DS_Store +package-lock.json diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index 70d87d5..a0f021a 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -5,6 +5,7 @@ You can see below the API reference of this module. ### `asciifyMatrix(pixels, options)` #### Params + - **Matrix** `pixels`: The pixels matrix (array of arrays of pixel objects). - **Object** `options`: An object to pass to `asciify-pixel` extended with the following fields: - `stringify` (Boolean): If `false`, the pixel objects will not be stringified. @@ -17,6 +18,7 @@ You can see below the API reference of this module. Stringifies the matrix. #### Params + - **Matrix** `input`: A matrix of pixels returned by the `asciify-pixel` package. #### Return @@ -26,6 +28,7 @@ Stringifies the matrix. Stringifies the input pixels. #### Params + - **Matrix** `input`: A matrix of pixels returned by the `asciify-pixel` package. #### Return @@ -35,6 +38,7 @@ Stringifies the input pixels. Joins the matrix characters. #### Params + - **Matrix** `input`: A matrix of characters (the stringified pixel objects). #### Return diff --git a/README.md b/README.md index 922b491..59eea0b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ + + # asciify-pixel-matrix - [![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/asciify-pixel-matrix.svg)](https://www.npmjs.com/package/asciify-pixel-matrix) [![Downloads](https://img.shields.io/npm/dt/asciify-pixel-matrix.svg)](https://www.npmjs.com/package/asciify-pixel-matrix) + [![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/asciify-pixel-matrix.svg)](https://www.npmjs.com/package/asciify-pixel-matrix) [![Downloads](https://img.shields.io/npm/dt/asciify-pixel-matrix.svg)](https://www.npmjs.com/package/asciify-pixel-matrix) > Asciifies a matrix of pixels. @@ -55,13 +57,15 @@ console.log(asciify([ // ################## ``` + + ## :question: Get Help 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 from me, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket: + 3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket: ## :memo: Documentation @@ -70,6 +74,7 @@ There are few ways to get help: ### `asciifyMatrix(pixels, options)` #### Params + - **Matrix** `pixels`: The pixels matrix (array of arrays of pixel objects). - **Object** `options`: An object to pass to `asciify-pixel` extended with the following fields: - `stringify` (Boolean): If `false`, the pixel objects will not be stringified. @@ -82,6 +87,7 @@ There are few ways to get help: Stringifies the matrix. #### Params + - **Matrix** `input`: A matrix of pixels returned by the `asciify-pixel` package. #### Return @@ -91,6 +97,7 @@ Stringifies the matrix. Stringifies the input pixels. #### Params + - **Matrix** `input`: A matrix of pixels returned by the `asciify-pixel` package. #### Return @@ -100,6 +107,7 @@ Stringifies the input pixels. Joins the matrix characters. #### Params + - **Matrix** `input`: A matrix of characters (the stringified pixel objects). #### Return @@ -119,6 +127,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` @@ -133,6 +142,7 @@ If you are using this library in one of your projects, add it in this list. :spa - [`bronos`](https://github.com/kswilster/bronos#readme) (by Keith Williams)—A sonos cli for bros + - [`bundle-buddy-webpack-plugin`](https://npmjs.com/package/bundle-buddy-webpack-plugin) (by Sean Larkin)—[![npm](https://badge.fury.io/js/bundle-buddy-webpack-plugin.svg)](https://badge.fury.io/js/bundle-buddy-webpack-plugin) [![dependencies](https://david-dm.org/TheLarkInn/bundle-buddy-webpack-plugin.svg)](https://david-dm.org/thelarkinn/bundle-buddy-webpac - [`image-to-ascii`](https://github.com/IonicaBizau/image-to-ascii)—A Node.JS module that converts images to ASCII art. ## :scroll: License diff --git a/package.json b/package.json index d837c17..fe18368 100644 --- a/package.json +++ b/package.json @@ -44,4 +44,4 @@ "bloggify.json", "bloggify/" ] -} \ No newline at end of file +}