Skip to content

Commit

Permalink
Fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gabrie-allaigre committed Jan 8, 2019
1 parent b0cd947 commit 6bbd24a
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Avatar builder, build multi avatar (cat, github, 8bit, square, identicon, etc) or compose avatar

![image](doc/multi.png)
![image](https://github.com/gabrie-allaigre/node-avatar-builder/raw/master/doc/multi.png)

## Install

Expand All @@ -20,8 +20,8 @@ avatar.create('gabriel').then(buffer => fs.writeFileSync('avatar-gabriel.png', b
avatar.create('allaigre').then(buffer => fs.writeFileSync('avatar-allaigre.png', buffer));
```

![image](doc/avatar-gabriel.png)
![image](doc/avatar-allaigre.png)
![image](https://github.com/gabrie-allaigre/node-avatar-builder/raw/master/doc/avatar-gabriel.png)
![image](https://github.com/gabrie-allaigre/node-avatar-builder/raw/master/doc/avatar-allaigre.png)

> Content typescript definition
Expand All @@ -41,7 +41,7 @@ const avatar = Avatar.triangleBuilder(128);
avatar.create('gabriel').then(buffer => {/* png buffer */});
```

![image](doc/triangle1.png)
![image](https://github.com/gabrie-allaigre/node-avatar-builder/raw/master/doc/triangle1.png)

### Square

Expand All @@ -57,7 +57,7 @@ const avatar = Avatar.squareBuilder(128);
avatar.create('gabriel').then(buffer => {/* png buffer */});
```

![image](doc/square1.png)
![image](https://github.com/gabrie-allaigre/node-avatar-builder/raw/master/doc/square1.png)

### Identicon

Expand All @@ -73,7 +73,7 @@ const avatar = Avatar.identiconBuilder(128);
avatar.create('gabriel').then(buffer => {/* png buffer */});
```

![image](doc/identicon1.png)
![image](https://github.com/gabrie-allaigre/node-avatar-builder/raw/master/doc/identicon1.png)

### GitHub

Expand All @@ -87,7 +87,7 @@ const avatar = Avatar.githubBuilder(128);
avatar.create('gabriel').then(buffer => {/* png buffer */});
```

![image](doc/github1.png)
![image](https://github.com/gabrie-allaigre/node-avatar-builder/raw/master/doc/github1.png)

### Cat

Expand All @@ -103,7 +103,7 @@ const avatar = Avatar.catBuilder(128);
avatar.create('gabriel').then(buffer => {/* png buffer */});
```

![image](doc/cat1.png)
![image](https://github.com/gabrie-allaigre/node-avatar-builder/raw/master/doc/cat1.png)

**Example 2 :**

Expand All @@ -120,7 +120,7 @@ const avatar = Avatar.builder(
avatar.create('gabriel').then(buffer => {/* png buffer */});
```

![image](doc/cat2.png)
![image](https://github.com/gabrie-allaigre/node-avatar-builder/raw/master/doc/cat2.png)

### 8 bit

Expand All @@ -136,7 +136,7 @@ const avatar = Avatar.male8bitBuilder(128);
avatar.create('gabriel').then(buffer => {/* png buffer */});
```

![image](doc/8bitmale.png)
![image](https://github.com/gabrie-allaigre/node-avatar-builder/raw/master/doc/8bitmale.png)

**Example 2 :**

Expand All @@ -148,7 +148,7 @@ const avatar = Avatar.female8bitBuilder(128);
avatar.create('gabriel').then(buffer => {/* png buffer */});
```

![image](doc/8bitfemale.png)
![image](https://github.com/gabrie-allaigre/node-avatar-builder/raw/master/doc/8bitfemale.png)


## Cache
Expand Down
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.0",
"version": "0.9.1",
"description": "Create a beautiful avatar for nodejs",
"main": "lib/index.js",
"scripts": {
Expand Down

0 comments on commit 6bbd24a

Please sign in to comment.