Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
IonicaBizau committed Sep 7, 2017
1 parent 7b31397 commit e771699
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 3 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,6 @@
*~
*.log
node_modules
*.env
.DS_Store
package-lock.json
4 changes: 4 additions & 0 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand All @@ -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
Expand All @@ -35,6 +38,7 @@ Stringifies the input pixels.
Joins the matrix characters.

#### Params

- **Matrix** `input`: A matrix of characters (the stringified pixel objects).

#### Return
Expand Down
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->


# 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.
Expand Down Expand Up @@ -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
Expand All @@ -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.
Expand All @@ -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
Expand All @@ -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
Expand All @@ -100,6 +107,7 @@ Stringifies the input pixels.
Joins the matrix characters.

#### Params

- **Matrix** `input`: A matrix of characters (the stringified pixel objects).

#### Return
Expand All @@ -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`
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@
"bloggify.json",
"bloggify/"
]
}
}

0 comments on commit e771699

Please sign in to comment.