# user-icon-generator

> Npm package to generate user icon using user's fullname.

Latest version **1.0.4** (published 2022-01-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install user-icon-generator
pnpm add user-icon-generator
yarn add user-icon-generator
bun add user-icon-generator
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2022-01-26 |
| First published | 2022-01-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Lokesh Choubisa |
| Maintainers | lokeshchoubisa |
| Keywords | user avatar, icons, icon generator, user icon, node, npm icon generator, user icon generator |

## Links

- npm: https://www.npmjs.com/package/user-icon-generator
- Repository: https://github.com/Lokeshchoubisa/user-icon-generator
- Homepage: https://github.com/Lokeshchoubisa/user-icon-generator#readme
- Issues: https://github.com/Lokeshchoubisa/user-icon-generator/issues
- npm.io page: https://npm.io/package/user-icon-generator

## Dependencies (1)

- [jimp](https://npm.io/package/jimp.md) ^0.16.1

## Alternatives

- [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) — 2.2M weekly downloads
- [roboto-fontface](https://npm.io/package/roboto-fontface.md) — 196.0K weekly downloads
- [@react-native-vector-icons/common](https://npm.io/package/@react-native-vector-icons/common.md) — 150.4K weekly downloads
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads
- [@react-md/material-icons](https://npm.io/package/@react-md/material-icons.md) — 1.6K weekly downloads

## Recent versions

- 1.0.4 (latest) — 2022-01-26
- 1.0.3 — 2022-01-22
- 1.0.2 — 2022-01-22
- 1.0.1 — 2022-01-22
- 1.0.0 — 2022-01-22

## README

## Getting started with icon generation
### Installation
This is a [Node.js](https://nodejs.org/en/) module available through the [npm](https://www.npmjs.com/package/user-icon-generator) registry.

Before installing, download and install  Node.js.

Installation of package is done using the npm install command:
```bash
$ npm install --save user-icon-generator
```
### Usage
* Requiring the module 

```javascript
var icons = require('user-icon-generator');
```
* This icons(fullname,color) method returns a image .

 ```javascript
 

var icons=require("user-icon-generator");

icons("Lokesh Choubisa","black").then((icon)=>
{
    if(!icon.error)
    {
        let image=icon.file;
        console.log(image);
    }
    else
    {
        console.log(icon.error);
    }   
})



```

### Output

<img align="center"  width="80" height="80" src="https://i.ibb.co/D8tqKg2/file.png" />


## Want to contribute ?

> Please check out this repository [here](https://github.com/Lokeshchoubisa/user-icon-generator)!
# Thankyou for being here! 😊

Check out my other Repositories [here](https://github.com/Lokeshchoubisa)

```
   _____ _                  ____                               _               _ 
  / ____| |                |  _|                              | |__           | |
 | (___ | |_ __ _ _   _    | |  _ __  ___ _ __     __   ____  | __ |   __  __ | |
  \___ \| __/ _` | | | |   | | |  _ \| __ |  _ \ / _  \| ___| | |  _  / _ \/ _` |
  ____) | || (_| | |_| |   | |_| |_| | | || | | |  ___/| |__  | |_| ||  __/ (_| | 
 |_____/ \__\__,_|\__, |   |___|_____|_| || | | |\___| | ___| |____ | \___|\__,_|
                   __/ |                                      
                  |___/                                       
```
## Connect 
> [Linkedin](https://www.linkedin.com/in/lokesh-choubisa-450a98195/)
> [Gmail](lokeshchoubisa26@gmail.com)

---
_Source: https://npm.io/package/user-icon-generator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._