Skip to content

Commit

Permalink
Update README with Deno usage instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
monooso committed Dec 8, 2023
1 parent 792994b commit 320c497
Showing 1 changed file with 5 additions and 16 deletions.
21 changes: 5 additions & 16 deletions README.md
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).

0 comments on commit 320c497

Please sign in to comment.