diff --git a/README.md b/README.md index f511033..c9c9029 100755 --- a/README.md +++ b/README.md @@ -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: @@ -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