Skip to content

Commit

Permalink
docs: readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
ssbarbee committed Nov 28, 2023
1 parent b3183d9 commit e2530e4
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

The `MetaMaskAvatar` component is a React functional component that takes in a required `address` property of type `string` and an optional `size` property of type `number`. It returns an image avatar of the given Ethereum address provided as a string and renders it within an `AvatarWrapper` component, which can be styled using the `className` property.

## Demo
## Demo 😈

Hosted [storybook](https://ssbarbee.github.io/react-metamask-avatar)

Expand All @@ -28,7 +28,7 @@ Hosted [storybook](https://ssbarbee.github.io/react-metamask-avatar)

```yarn add react-metamask-avatar```

## Props
## Props ℹ️

### address
The **required** address property is a **string** of length 42 that represents an Ethereum address. If it is not provided or does not meet the expected length, the component returns null.
Expand All @@ -52,7 +52,7 @@ export const App: React.FunctionComponent = () => {
}
```

## FAQ
## FAQ 🙋❓

### I want to add custom styling. How can I do that?

Expand Down

0 comments on commit e2530e4

Please sign in to comment.