From 4893859eaf57e0ac5a477de3826c2f4b2c6dad22 Mon Sep 17 00:00:00 2001 From: jvherck Date: Wed, 24 Apr 2024 19:20:17 +0200 Subject: [PATCH] md edits --- CHANGELOG.md | 101 ---------------------------------------------- README.md | 14 +++---- docs/changelog.md | 2 +- 3 files changed, 8 insertions(+), 109 deletions(-) delete mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index e58ecd7..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,101 +0,0 @@ -# Changelog -To find the full documentation go to [https://jvh.gitbook.io/dicebear/](https://jvh.gitbook.io/dicebear/) \ -You can click certain `blocks` to go to its documentation page. \ -\ -If you encounter any bugs or errors, please open an [issue](https://github.com/jvherck/dicebear/issues). - - ---- - - -## v2.7.4 -2024-04-24 - -### Back-end -- Back-end cleanup -- Dicebear version upgrade to 8.x (which contains API bug fixes) - - ---- - - -## v2.7.3 -2024-03-09 - -### Added -- [`styles_metadata`](https://jvh.gitbook.io/dicebear/reference/models#variables) (models.py) to directly get metadata of every style - -### Back-end -- Made usage stats opt-in with environment variable [`ENABLE_PYTHON_DICEBEAR_USAGE_STATS`](https://jvh.gitbook.io/dicebear/start/statistics) set to true - -### Fixed -- [`notionists`](https://jvh.gitbook.io/dicebear/start/customization#styles) and [`notionists-neutral`](https://jvh.gitbook.io/dicebear/start/customization#styles) were not implemented but have been added now - - ---- - - -## v2.7.2 -2023-12-12 - -### Added -- New attribute [`schema`](https://jvh.gitbook.io/dicebear/reference/avatar#properties) for [`DAvatar`](https://jvh.gitbook.io/dicebear/reference/avatar#class-davatar) class - -### Back-end -- Removed `test` parameter on all functions -- Improved type hinting and imports - - ---- - - -## v2.7.0 -2023-08-29 - -### Added -- New style [`rings`](https://jvh.gitbook.io/dicebear/start/customization#styles) -- New function [`DStyle.get_schema(style: str)`](https://jvh.gitbook.io/dicebear/reference/models#def-get_schema) to get the schema (all properties) of the given avatar style - -### Back-end -- Upgrade to Dicebear new API version 7.0 - - ---- - - -## v2.6.1 -2023-04-11 - -### Added -- New style [`notionists`](https://jvh.gitbook.io/dicebear/start/customization#styles) -- New style [`notionists-neutral`](https://jvh.gitbook.io/dicebear/start/customization#styles) - -### Back-end -- Upgrade to Dicebear new API version 6.0 - - ---- - - -## v2.5.2 -2023-03-21 - -### Back-end -- The package now pings an API to update the usage statistics (nothing personal is stored, it simply increments the -amount of times certain functions have been used) - - ---- - - -## v2.5.1 -2023-03-16 - -### Removed -- Properties `DAvatar.text` and `DAvatar.bytes` - -### Added -- Methods [`DAvatar.text(format)`](https://jvh.gitbook.io/dicebear/reference/avatar#def-text) and [`DAvatar.bytes(format)`](https://jvh.gitbook.io/dicebear/reference/avatar#def-bytes) - -### Fixed -- [`DAvatar.pillow()`](https://jvh.gitbook.io/dicebear/reference/avatar#def-pillow) no longer raises error for no reason diff --git a/README.md b/README.md index 178d25d..3fa25a1 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,9 @@ ![Maintenance](https://img.shields.io/maintenance/yes/2024) ![PyPI - Status](https://img.shields.io/pypi/status/dicebear) -Always keep an eye on https://jvh.gitbook.io/dicebear/ for updates and warnings about this packages! +Always keep an eye on https://dicebear.vhjan.me/ for updates and warnings about this packages! -[`dicebear`](https://pypi.org/project/dicebear/) is an API wrapper for https://dicebear.com. Using this wrapper you can get custom avatars for your program. \ +[`dicebear`](https://pypi.org/project/dicebear/) is a Python API wrapper for https://dicebear.com. Using this wrapper you can get custom avatars for your program. \ For an example go to [`examples/dicebear.py`](https://github.com/jvherck/dicebear/tree/main/examples). @@ -18,18 +18,18 @@ For an example go to [`examples/dicebear.py`](https://github.com/jvherck/dicebea ## Useful links -* Docs: https://jvh.gitbook.io/dicebear/ +* Official Dicebear: https://dicebear.com/ +* Docs: https://dicebear.vhjan.me/ * PyPI: https://pypi.org/project/dicebear/ * GitHub: https://github.com/jvherck/dicebear -* Dicebear: https://dicebear.com/ -* Dicebear CLI: https://github.com/jvherck/dicebear-cli +* Dicebear Python CLI: https://github.com/jvherck/dicebear-cli --- ## Changelog -Find the changelog here: https://github.com/jvherck/dicebear/blob/main/CHANGELOG.md +Find the changelog here: https://dicebear.vhjan.me/changelog --- @@ -244,4 +244,4 @@ making this amazing API and to [all artists](https://dicebear.com/licenses) for ## Licenses and privacy policy - Dicebear **Licenses**: https://dicebear.com/licenses - Dicebear **Privacy Policy**: https://dicebear.com/legal/privacy-policy -- Dicebear Python API wrapper (this project): https://jvh.gitbook.io/dicebear/license +- Dicebear Python API wrapper (this project): https://dicebear.vhjan.me/license diff --git a/docs/changelog.md b/docs/changelog.md index 4a37229..f02d51a 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -14,7 +14,7 @@ If you encounter any bugs or errors, please open an [issue](https://github.com/j ### Back-end * Back-end cleanup -* Dicebear version upgrade to 8.x (which contains API bug fixes) +* Dicebear version upgrade to 8.x (API bug fixes) ***