		@@ -5,2 +5,24 @@ # [my-avatars](https://www.npmjs.com/package/my-avatars)

		## Docs

		- `Item`
		- `new Item(path, opts)`
		- `path` is the path to the image
		- `opts`
		- `x`: `Number` - x-coord to place the image
		- `y`: `Number` - y-coord to place the image
		- `check`: `Boolean` - check if the image can be found
		- `replace`: `Array` of `Object`'s - filled with colors to replace from and to
		- `from`: `String` - color to replace from, in the format of `r,g,b` - e.g. `128,128,128`
		- `to`: `String` - color to replace to, in the format of `r,g,b` - e.g. `128,128,128`
		- `Layer`
		- `new Layer(name, idx)`
		- `name`: `String` - a friendly name to recognise
		- `idx`: `Number` - the z-index of the layer
		- `Generator`
		- `new Generator(width, height, parentElm)`
		- `width`: `Number` - width of the avatar
		- `height`: `Number` - height of the avatar
		- `parentElm`: `Element` - element to place avatar within

		## Usage
		@@ -22,3 +44,3 @@

		> NB: No two layers can have the same index.
		> NB: No two layers can't have the same index.

		@@ -25,0 +47,0 @@ Next-up, we'll need to pass in all of the `Item`'s, like so: `faceLayer.addItem(item)`.

my-avatars - npm Package Compare versions

New alerts