diff --git a/README.md b/README.md index 729667f..cc24017 100644 --- a/README.md +++ b/README.md @@ -33,9 +33,12 @@ Table of Contents
  1. About The Project
  2. - + +
  3. Project Structure @@ -82,35 +85,39 @@ If you simply want to utilize my API, you can simply add an `img` tag to your si The style is controlled with the CSS variables defined `assets/style.css`. These constants can also be modified to adjust the appearance: - **SVG Dimensions**: - `width`: Overall width of the SVG (default: 150). - `height`: Overall height of the SVG (default: 20). - `label_width`: Width of the left section (label background) (default: 100). - `counter_width`: Width of the right section (counter background) (default: 50). - `radius`: Border radius for rounded corners (default: 3). + - `width`: Overall width of the SVG (default: 150). + - `height`: Overall height of the SVG (default: 20). + - `label_width`: Width of the left section (label background) (default: 100). + - `counter_width`: Width of the right section (counter background) (default: 50). + - `radius`: Border radius for rounded corners (default: 3). - **Gradient Settings**: - `grad_stop1_color`: Color of the first gradient stop (default: #bbb). - `grad_stop1_opacity`: Opacity of the first gradient stop (default: 0.1). - `grad_stop2_opacity`: Opacity of the second gradient stop (default: 0.1). + - `grad_stop1_color`: Color of the first gradient stop (default: #bbb). + - `grad_stop1_opacity`: Opacity of the first gradient stop (default: 0.1). + - `grad_stop2_opacity`: Opacity of the second gradient stop (default: 0.1). - **Text Settings**: - `font_family`: Font family used for the counter text (default: 'Metrophobic', 'Comfortaa', sans-serif). - `font_size`: Font size for the text (default: 11). - `label_offset_x`: X-coordinate for the label text (default: 50). - `label_offset_y`: Y-coordinate for the label text (default: 15). - `counter_offset_x`: X-coordinate for the counter text (default: 125). - `counter_offset_y`: Y-coordinate for the counter text (default: 15). - `shadow_fill`: Color used for the text drop shadow (default: #010101). - `shadow_opacity`: Opacity of the text drop shadow (default: 0.3). + - `font_family`: Font family used for the counter text (default: 'Metrophobic', 'Comfortaa', sans-serif). + - `font_size`: Font size for the text (default: 11). + - `label_offset_x`: X-coordinate for the label text (default: 50). + - `label_offset_y`: Y-coordinate for the label text (default: 15). + - `counter_offset_x`: X-coordinate for the counter text (default: 125). + - `counter_offset_y`: Y-coordinate for the counter text (default: 15). + - `shadow_fill`: Color used for the text drop shadow (default: #010101). + - `shadow_opacity`: Opacity of the text drop shadow (default: 0.3). - **Color Settings (NyakoTech Inspired)**: - `background_label`: Background for the label section (default: #18181b). - `background_counter`: Background for the counter section (default: #DC26B6). - `label_color`: Color of the label text (default:#fff). - `counter_color`: Color of the counter text (default:#fff). + - `background_label`: Background for the label section (default: #18181b). + - `background_counter`: Background for the counter section (default: #DC26B6). + - `label_color`: Color of the label text (default:#fff). + - `counter_color`: Color of the counter text (default:#fff).

    (back to top)

    +### Built With +- ![Rust](https://img.shields.io/badge/rust-%23000000.svg?style=for-the-badge&logo=rust&logoColor=white) +- ![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white) + ## Project Structure The project is organized as follows: @@ -275,6 +282,12 @@ Project Link: [https://github.com/AitorAstorga/visit_counter](https://github.com

    (back to top)

    +## Acknowledgments + +This is based on [Anton Komarev's](https://komarev.com/anton) [github-profile-views-counter](https://github.com/antonkomarev/github-profile-views-counter), but made in Rust. + +

    (back to top)

    + [contributors-shield]: https://img.shields.io/github/contributors/AitorAstorga/visit_counter.svg?style=for-the-badge [contributors-url]: https://github.com/AitorAstorga/visit_counter/graphs/contributors