-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update README with Deno usage instructions
- Loading branch information
Showing
1 changed file
with
5 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,13 @@ | ||
# Avatar | ||
|
||
Generates a random SVG avatar for any given identifier. Always generates the | ||
same avatar for the same identifier. | ||
|
||
## Install | ||
|
||
```bash | ||
npm install --save @monooso/avatar | ||
``` | ||
Generates a random SVG avatar for any given identifier. Always generates the same avatar for the same identifier. | ||
|
||
## Usage | ||
|
||
```javascript | ||
import { svg } from "@monooso/avatar"; | ||
```typescript | ||
import { generateSvg } from "https://deno.land/x/avatar@1.0.0/mod.ts"; | ||
|
||
svg("some-identifier-string").then((avatar) => console.log(avatar)); | ||
const avatar = await generateSvg("some-identifier-string"); | ||
``` | ||
|
||
## Credits | ||
|
||
The avatars are generated using elements from | ||
[the splendid Miniavs avatar builder](https://www.figma.com/community/file/923211396597067458), | ||
by [Webpixels](https://www.figma.com/@webpixels). | ||
The avatars are generated using elements from [the splendid Miniavs avatar builder](https://www.figma.com/community/file/923211396597067458), by [Webpixels](https://www.figma.com/@webpixels). |