Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/okunishinishi/node-dotpic
Doc picture generator
https://github.com/okunishinishi/node-dotpic
Last synced: 2 months ago
JSON representation
Doc picture generator
- Host: GitHub
- URL: https://github.com/okunishinishi/node-dotpic
- Owner: okunishinishi
- License: mit
- Created: 2016-08-31T04:16:04.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-08-31T05:53:50.000Z (over 8 years ago)
- Last Synced: 2024-04-29T07:43:47.468Z (9 months ago)
- Language: JavaScript
- Size: 10.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
dotpic
==========
[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
[![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]
[bd_repo_url]: https://github.com/okunishinishi/node-dotpic
[bd_travis_url]: http://travis-ci.org/okunishinishi/node-dotpic
[bd_travis_shield_url]: http://img.shields.io/travis/okunishinishi/node-dotpic.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/okunishinishi/node-dotpic
[bd_travis_com_shield_url]: https://api.travis-ci.com/okunishinishi/node-dotpic.svg?token=
[bd_license_url]: https://github.com/okunishinishi/node-dotpic/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/okunishinishi/node-dotpic
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/okunishinishi/node-dotpic.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/okunishinishi/node-dotpic.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/okunishinishi/node-dotpic
[bd_gemnasium_shield_url]: https://gemnasium.com/okunishinishi/node-dotpic.svg
[bd_npm_url]: http://www.npmjs.org/package/dotpic
[bd_npm_shield_url]: http://img.shields.io/npm/v/dotpic.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
Doc picture generator
Installation
-----
```bash
$ npm install dotpic --save
```
Usage
---------
```javascript
'use strict'
const dotpic = require('dotpic')
const fs = require('fs')
// Write dot picture
let src = `
000011110000
000001100000
000001100000
000001100000
100001100001
111111111111
111111111111
100001100001
000001100000
000001100000
000001100000
000001100000
000001100000
000001100000
000001100000
000001100000
000011110000
`
let svg = dotpic(src, {
colors: {
'0': '#444',
'1': '#FFF'
}
})
fs.writeFile('my-svg.svg', svg)
```
Signature
---------
`dotpic(src, options) -> string`
### Params
| Name | Type | Description |
| ----- | --- | -------- |
| src | string | image data |
| options | Object | Optional settings |
| options.colors | Object | Color data |
| options.width | number | Image width |
| options.height | number | Image height |
| options.background | string | Background color |
License
-------
This software is released under the [MIT License](https://github.com/okunishinishi/node-dotpic/blob/master/LICENSE).
Links
------