diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100755 index 00000000..7a9b2e5e --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,20 @@ +# v2.0.0 + +## Breaking Changes + +This release contains breaking changes as the image was rewritten using Go to decrease size and accommodate new features: + +* Updated docker-compose file with new variables and volume mounts +* Docker Hub image has been deprecated and will no longer receive updates + +## What's Changed + +* Reduced image size (125MB --> 8MB) after replacing Node.js with Go +* Support for local icon files +* Volume mounts for users hosting icon files locally +* Implemented caching to reduce external requests for commonly used assets +* Detailed logging + +# v1.0.0 + +* Initial release \ No newline at end of file diff --git a/README.md b/README.md index 2ab43cd1..ea541c72 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,12 @@
-## selfh.st/icons +### selfh.st/icons [selfh.st/icons](https://selfh.st/icons) is a collection of logos and icons for self-hosted (and non-self-hosted) software. @@ -16,10 +17,10 @@ The collection is available for browsing via the directory at [selfh.st/icons](h To self-host the collection, users should refer to the [repository's wiki](https://github.com/selfhst/icons/wiki). -## Custom Colors +### Custom Colors By default, the directory provides SVG icons (when available) in standard, dark, and light colors. Users looking to display the icons using colors of their choice can become a [paid member of selfh.st](https://selfh.st/perks) or [deploy the collection themselves](https://github.com/selfhst/icons/wiki). -## Requests +### Requests Requests for new or updated icons can be made via the repository's [discussions](https://github.com/selfhst/icons/discussions). To ensure quality and consistency, pull requests will not be accepted from unapproved members.