Skip to content

Commit

Permalink
Some tweaks to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
gabrieledarrigo committed May 10, 2020
1 parent f68af64 commit 85b64a6
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
# Node.js monsterId
> 👾 Create your unique monstrous avatar
![image](https://user-images.githubusercontent.com/1985555/81498938-0a2c2080-92c8-11ea-96cd-a6f532eca7fe.png)

![GitHub Workflow Status](https://img.shields.io/github/workflow/status/gabrieledarrigo/monsterid/Node.js%20CI) ![npm](https://img.shields.io/npm/v/monsterid)

![Node.js CI](https://github.com/gabrieledarrigo/monsterid/workflows/Node.js%20CI/badge.svg)

Node.js implementation of [monsterId](http://www.splitbrain.org/projects/monsterid) PHP library.
monsterId is the Node.js implementation of [monsterId](http://www.splitbrain.org/projects/monsterid) PHP library.
It creates a unique avatar starting from a string, typically a username, used to generate a unique seed number.

## Installation

This library depends on [node-gd](https://github.com/y-a-v-a/node-gd) so, in order to use monsterId, you need to have [libgd](https://github.com/libgd) installed on your system.
You can follow node-gd installastion's instructions here: [node-gd](https://github.com/y-a-v-a/node-gd#installation).
You can follow node-gd installastion's instructions [here](https://github.com/y-a-v-a/node-gd#installation).

To install monsterId just type the following command:

Expand Down Expand Up @@ -48,14 +47,14 @@ const avatar = monsterId('username', {

## Contributing

The library is authored in ES6, transpiled with [Babel](https://babeljs.io/), and exported as CommonJS module.
monsterId is authored in ES6, transpiled with [Babel](https://babeljs.io/), and exported as a CommonJS module.
To transpile the src files run this command:

```
$ npm run build
```

To launch all unit tests (with [Jest](https://jestjs.io/)) run this command:
To launch unit tests suite (with [Jest](https://jestjs.io/)) run this command:

```
$ npm run test
Expand Down

0 comments on commit 85b64a6

Please sign in to comment.