Skip to content

Commit

Permalink
Write a better README
Browse files Browse the repository at this point in the history
  • Loading branch information
gabrieledarrigo committed May 2, 2020
1 parent b22ed41 commit 9d74499
Show file tree
Hide file tree
Showing 6 changed files with 561 additions and 677 deletions.
3 changes: 2 additions & 1 deletion .eslintignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
node_modules/
dist/
dist/
example.js
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,16 @@ It creates a unique avatar starting from a string, typically a username, used to
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).

To install monsterId just
To install monsterId just type the following command:

```
$ npm install monsterid
```

## How to use

The usage is actually simple; just import the library an call `monsterId` function with a username to have back a binary object which represents
your unique avatar 👾.
The usage is actually simple;
Import the library an call `monsterId` function with a username to have back a binary object which represents your unique avatar 👾.

```js
const http = require('http');
Expand Down
2 changes: 1 addition & 1 deletion server.js → example.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const http = require('http');
const monsterId = require('./dist/index');
const monsterId = require('monsterId');

http.createServer(async (req, res) => {
const username = 'username';
Expand Down
Loading

0 comments on commit 9d74499

Please sign in to comment.