Skip to content

Commit

Permalink
Merge pull request #8 from ClydeDz/public-release
Browse files Browse the repository at this point in the history
Add installation information in the readme file. Add tweet this button in the readme file. Bump version to 1.0.0.
  • Loading branch information
ClydeDz authored Dec 17, 2020
2 parents ec715a2 + bd128b4 commit 1574683
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,20 @@ Gets a random avatar URL from a collection of different avatar generation servic
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=ClydeDz_give-me-an-avatar-npm&metric=alert_status)](https://sonarcloud.io/dashboard?id=ClydeDz_give-me-an-avatar-npm)
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=ClydeDz_give-me-an-avatar-npm&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=ClydeDz_give-me-an-avatar-npm)
![MIT License](https://img.shields.io/static/v1.svg?label=📜%20License&message=MIT&color=informational)
[![npm](https://img.shields.io/npm/v/give-me-an-avatar?color=brightgreen&logo=npm)](https://bit.ly/give-me-an-avatar)
[![npm](https://img.shields.io/npm/v/give-me-an-avatar?color=brightgreen&logo=npm)](https://bit.ly/give-me-an-avatar)
[![Tweet about this](https://img.shields.io/static/v1.svg?label=Tweet%20about%20this&message=🎵&color=blue&logo=twitter&style=social)](https://ctt.ac/k925T)

## Usage
Install the package from npm using the following command.
```NPM Config
npm i give-me-an-avatar
```

After installing, simply import Give Me an Avatar in your file.
```javascript
const avatars = require("give-me-an-avatar");
```
Consume the `giveMeAnAvatar()` API to get an avatar URL that you can use directly as an image. You can either call the method directly or supply the settings object to customize your avatar (only a bit). All settings are pretty self-explanatory and are not mandatory. For example:
Consume the `giveMeAnAvatar()` API to get an avatar URL that you can use directly as an image. You can either call the method without any parameters or supply the settings object to customize your avatar a bit. All settings are pretty self-explanatory and are not mandatory. For example:
```javascript
let image = avatars.giveMeAnAvatar({
Name: "John Smith",
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "give-me-an-avatar",
"displayName": "Give Me an Avatar",
"version": "0.7.0",
"version": "1.0.0",
"description": "Gets a random avatar URL from a collection of different avatar generation services.",
"source": "./src/give-me-an-avatar.ts",
"main": "./dist/give-me-an-avatar.js",
Expand Down

0 comments on commit 1574683

Please sign in to comment.