		@@ -1,38 +0,30 @@
		This project was bootstrapped with [Create React Library](https://github.com/dimimikadze/create-react-library).
		![boring avatars preview](public/boring-avatars-preview.png)

		All library files are located inside src/lib folder.
		# Boring Avatars — Avatars for react projects

		Inside src/demo folder, you can test your library while developing.
		## Install

		## Available Scripts
		```jsx
		import Avatar from "boring-avatars";
		```

		In the project directory, you can run:
		## Usage

		### `npm start` or `yarn start`
		```jsx
		<div>
		<Avatar size="64px" variant="abstract" name="Mike" />
		</div>
		```

		Runs the library in development mode. Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
		### Props

		### `npm run test` or `yarn run test`
		\| Prop \| Type \|
		\| ------- \| ------------------------------ \|
		\| size \| number or string \|
		\| name \| string \|
		\| variant \| oneOf: "abstract", "geometric" \|

		Runs the test watcher in an interactive mode.
		---

		### `npm run build` or `yarn build`

		Builds the library for production to the `build` folder.
		It correctly bundles React in production mode and optimizes the build for the best performance.

		### `npm publish`

		Publishes the library to NPM.

		## Typescript

		[Adding Typescript support](https://gist.github.com/DimiMikadze/f25e1c5c70fa003953afd40fa9042517)

		## Troubleshooting

		### Usage of other libraries within your library

		- Add the library as a peer dependency in package.json (effectively requiring the calling project to provide this dependency)
		- Add the library as a dev dependency in package.json (effectively allowing this library to successfully build without complaining about not having this dependency)
		- Add the library to the externals config in your webpack.config file(s). By default, only react and react-dom are there, meaning that those are the only two libraries that you can use within your new shared library.
		Built with
		[Create React Library](https://github.com/DimiMikadze/create-react-library)

boring-avatars - npm Package Compare versions

New alerts

Fixed alerts

Improved metrics

Worsened metrics