Skip to content

Commit

Permalink
Fix readme and release version 1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
gabrie-allaigre committed Feb 2, 2019
1 parent 6bbd24a commit 1584dda
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ npm install avatar-builder --save
## Usage

```javascript
const Avatar = require('./lib');
const Avatar = require('avatar-builder');

const avatar = Avatar.builder(Avatar.Image.margin(Avatar.Image.circleMask(Avatar.Image.identicon())),128,128, {cache: Avatar.Cache.lru()});
avatar.create('gabriel').then(buffer => fs.writeFileSync('avatar-gabriel.png', buffer));
Expand All @@ -34,7 +34,7 @@ More example in [sample.js](./sample.js)
**Example 1 :**

```javascript
const Avatar = require('./lib');
const Avatar = require('avatar-builder');

const avatar = Avatar.triangleBuilder(128);

Expand All @@ -50,7 +50,7 @@ Source : https://github.com/flouthoc/minBlock.js
**Example 1 :**

```javascript
const Avatar = require('./lib');
const Avatar = require('avatar-builder');

const avatar = Avatar.squareBuilder(128);

Expand All @@ -66,7 +66,7 @@ Source : https://github.com/donpark/identicon
**Example 1 :**

```javascript
const Avatar = require('./lib');
const Avatar = require('avatar-builder');

const avatar = Avatar.identiconBuilder(128);

Expand All @@ -80,7 +80,7 @@ avatar.create('gabriel').then(buffer => {/* png buffer */});
**Example 1 :**

```javascript
const Avatar = require('./lib');
const Avatar = require('avatar-builder');

const avatar = Avatar.githubBuilder(128);

Expand All @@ -96,7 +96,7 @@ Images sources : CC-By 4.0 attribution: David Revoy https://framagit.org/Deevad
**Example 1 :**

```javascript
const Avatar = require('./lib');
const Avatar = require('avatar-builder');

const avatar = Avatar.catBuilder(128);

Expand All @@ -108,7 +108,7 @@ avatar.create('gabriel').then(buffer => {/* png buffer */});
**Example 2 :**

```javascript
const Avatar = require('./lib');
const Avatar = require('avatar-builder');

const avatar = Avatar.builder(
Avatar.Image.margin(Avatar.Image.roundedRectMask(Avatar.Image.compose(
Expand All @@ -129,7 +129,7 @@ Images sources : https://github.com/o1egl/govatar
**Example 1 :**

```javascript
const Avatar = require('./lib');
const Avatar = require('avatar-builder');

const avatar = Avatar.male8bitBuilder(128);

Expand All @@ -141,7 +141,7 @@ avatar.create('gabriel').then(buffer => {/* png buffer */});
**Example 2 :**

```javascript
const Avatar = require('./lib');
const Avatar = require('avatar-builder');

const avatar = Avatar.female8bitBuilder(128);

Expand All @@ -158,7 +158,7 @@ Compose cache
**Example, cache with lru and folder**

```javascript
const Avatar = require('./lib');
const Avatar = require('avatar-builder');

const avatar = Avatar.catBuilder(128, { cache: Avatar.Cache.compose(Avatar.Cache.lru(), Avatar.Cache.folder()) });

Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "avatar-builder",
"version": "0.9.1",
"version": "1.0.0",
"description": "Create a beautiful avatar for nodejs",
"main": "lib/index.js",
"scripts": {
Expand Down

0 comments on commit 1584dda

Please sign in to comment.