Skip to content

Commit

Permalink
Minor documentation tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
qrohlf committed Apr 6, 2015
1 parent 8ae2d65 commit 4847ec1
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
6 changes: 4 additions & 2 deletions Readme.md
Expand Up @@ -9,7 +9,9 @@ Trianglify is a library that I wrote to generate nice SVG background images like

It was inspired by [btmills/geopattern](https://github.com/btmills/geopattern) and the initial version was written in a single day because I got fed up with Adobe Illustrator.

v0.2.0 represents a ground-up rewrite of the original, eliminating the dependency on d3.js and adding the ability to render to PNG or canvas. **v0.1.x users should note that the API has changed and v0.2.0 is not backwards-compatible**.
Version 0.2.0 represents a ground-up rewrite of the original which eliminates the dependency on d3.js, streamlines rendering, and reworks the API for consistiency and ease-of-use.

*(v0.1.x users should note that the v0.2.0 API has changed significantly and is not backwards-compatible)*

# Getting Trianglify

Expand Down Expand Up @@ -46,7 +48,7 @@ git clone https://github.com/qrohlf/trianglify.git
</script>
```

See https://qrohlf.com/trianglify for a overview on getting started and a demonstration of some configuration options.
See https://qrohlf.com/trianglify for interactive examples and a walkthrough of the most commonly-used Trianglify options.


# API
Expand Down
7 changes: 4 additions & 3 deletions examples/save-as-png.js
Expand Up @@ -11,10 +11,11 @@ if (process.argv.length < 3) {

// Generate a pattern and then grab the PNG data uri
var pngURI = Trianglify({
width: 1920,
height: 1080,
cell_size: Math.random()*200 + 40,
x_colors: 'random',
width: 600,
height: 400,
cell_size: 40
variance: Math.random(),
}).png();

// Strip off the uri part of the data uri, leaving the data
Expand Down

0 comments on commit 4847ec1

Please sign in to comment.