Update readme with example usages

This commit is contained in:
Juan Sebastián Montoya 2024-09-26 20:07:47 -05:00
parent 819379fba4
commit 6a07975062

View file

@ -2,9 +2,26 @@
A self-hosted avatars API using some of the [DiceBear](https://www.dicebear.com/) CC0 styles A self-hosted avatars API using some of the [DiceBear](https://www.dicebear.com/) CC0 styles
# Installation You can take a look at my own self-hosted version here: https://avatars.jusemon.com
## Development The following endpoints are available:
- https://avatars.jusemon.com/list
- https://avatars.jusemon.com/random
- https://avatars.jusemon.com/:seed
The size of the image and the style can be changed with the following query params:
- `size`: any number between `16` and `512`
- `style`: see the list endpoint, the valid values are defined by the property `key`
## Example:
https://avatars.jusemon.com/jusemon?size=512&style=open-peeps where jusemon is the :seed
## Installation
### Development
For run locally it needs a `.env` file with the environment variables defined in the `.env.example` For run locally it needs a `.env` file with the environment variables defined in the `.env.example`
@ -13,7 +30,7 @@ ALLOWED_ORIGINS includes a comma separated list for the allowed CORS sites.
Install dependencies `npm install` or `yarn` Install dependencies `npm install` or `yarn`
To start the project run `npm run dev` or `yarn dev` To start the project run `npm run dev` or `yarn dev`
## Production ### Production
For run it in docker just run `docker compose up` For run it in docker just run `docker compose up`
@ -27,7 +44,7 @@ For run it in docker just run `docker compose up`
- Created by Juan Sebastián Montoya - Created by Juan Sebastián Montoya
## Credits for Styles: ### Credits for Styles:
| Title | Creator | Source | Homepage | License | | Title | Creator | Source | Homepage | License |
| ---------- | ------------- | -------------------------------------------------------- | -------------------------------- | ------- | | ---------- | ------------- | -------------------------------------------------------- | -------------------------------- | ------- |