diff --git a/README.md b/README.md index 650a5b8..38158b0 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,57 @@ -# better-light-theme-for-ttrss -A better light theme for Tiny Tiny RSS, inspired by CommaFeed +# Better light theme for Tiny Tiny RSS + +A better light theme for Tiny Tiny RSS, inspired by the look of [CommaFeed](https://github.com/Athou/commafeed). It's just a few modifications I made so it suits my personal preferences better. + +**This theme is made for always expanded articles and 'combined mode' turned on**, otherwise you're not going to see most of the differences. + +## Features + +- More whitespace around and between articles, so they don't blend together as much +- Set a max width on article content +- Better visible article header and footer +- Feed panel has less whitespace but better text contrast +- In feed panel, the scrollbar is only shown when overing over the panel +- in feed panel the unread count labels are not shown on categories, only on feeds +- In Firefox, the feed panel scrollbar is [thin](https://developer.mozilla.org/en-US/docs/Web/CSS/scrollbar-width) (Chrome, *please* support this in the future...) +- *Stylish drop shadows!* + +See screenshot comparison below too. + +## Installation + +1. Copy the CSS file into the `themes.local` folder. +2. Select the theme in TT-RSS preferences. + +This theme depends on the 'light' theme being installed, but it should be installed by default. + +## Screenshots + +#### My theme + + +#### Original Light theme for reference + + +## License + +### MIT License + +Copyright (c) 2021 clb92 + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE.