From 2da68633ba7cc9e46bb47cd991e56ae00231e324 Mon Sep 17 00:00:00 2001 From: josepmartins Date: Wed, 3 Jan 2024 05:30:45 +0100 Subject: [PATCH] Update README --- README.md | 37 ++++++++++--------------------------- 1 file changed, 10 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index a58565b..9597e99 100644 --- a/README.md +++ b/README.md @@ -10,21 +10,6 @@ Boring avatars is a tiny JavaScript React library that generates custom, SVG-bas ![boring avatars preview](https://github.com/boringdesigners/boring-avatars/blob/master/public/boring-avatars-preview.png?raw=true) - -## Sponsors - - - - - - Clerk – Authentication & User Management for React - - - -[Clerk](https://clerk.com?utm_source=sponsorship&utm_medium=github&utm_campaign=boringavatars&utm_content=06_12_2023) provides drop-in authentication for React and has built-in support for Boring Avatars. - - ## Install ``` @@ -34,27 +19,26 @@ npm install boring-avatars ## Usage ```jsx -import Avatar from "boring-avatars"; +import Avatar from 'boring-avatars'; ; ``` ### Props -| Prop | Type | -| ------- | ------------------------------------------------------------ | -| size | number or string, `40px` (default) | -| square | boolean: `false` (default) | -| title | boolean: `false` (default) | -| name | string | +| Prop | Type | +| ------- | ---------------------------------------------------------------------- | +| size | number or string, `40px` (default) | +| square | boolean: `false` (default) | +| title | boolean: `false` (default) | +| name | string | | variant | oneOf: `marble` (default), `beam`, `pixel`,`sunset`, `ring`, `bauhaus` | -| colors | array of colors | - +| colors | array of colors | ## Service @@ -65,8 +49,7 @@ To choose a random avatar from a specific user and a color palette, the format f ``` https://source.boringavatars.com/marble/120/Maria%20Mitchell?colors=264653,2a9d8f,e9c46a,f4a261,e76f51 ``` -![Avatar for Maria Mitchell](https://source.boringavatars.com/marble/120/Maria%20Mitchell?colors=264653,2a9d8f,e9c46a,f4a261,e76f51) +![Avatar for Maria Mitchell](https://source.boringavatars.com/marble/120/Maria%20Mitchell?colors=264653,2a9d8f,e9c46a,f4a261,e76f51) For more information, [check out the README](https://github.com/hihayk/boring-avatars-service/blob/main/README.md) -