init

hypr/catppuccin-hyprlock/README.md

@@ -0,0 +1,70 @@
+<h3 align="center">
+	<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/logos/exports/1544x1544_circle.png" width="100" alt="Logo"/><br/>
+	<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/misc/transparent.png" height="30" width="0px"/>
+	Catppuccin for <a href="https://github.com/hyprwm/hyprlock">Hyprlock</a>
+	<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/misc/transparent.png" height="30" width="0px"/>
+</h3>
+
+<p align="center">
+	<a href="https://github.com/catppuccin/hyprlock/stargazers"><img src="https://img.shields.io/github/stars/catppuccin/hyprlock?colorA=363a4f&colorB=b7bdf8&style=for-the-badge"></a>
+	<a href="https://github.com/catppuccin/hyprlock/issues"><img src="https://img.shields.io/github/issues/catppuccin/hyprlock?colorA=363a4f&colorB=f5a97f&style=for-the-badge"></a>
+	<a href="https://github.com/catppuccin/hyprlock/contributors"><img src="https://img.shields.io/github/contributors/catppuccin/hyprlock?colorA=363a4f&colorB=a6da95&style=for-the-badge"></a>
+</p>
+
+<p align="center">
+	<img src="assets/preview.webp"/>
+</p>
+
+## Previews
+
+<details>
+  <summary>🌻 Latte</summary>
+  <img src="assets/latte.webp"/>
+</details>
+<details>
+  <summary>🪴 Frappé</summary>
+  <img src="assets/frappe.webp"/>
+</details>
+<details>
+  <summary>🌺 Macchiato</summary>
+  <img src="assets/macchiato.webp"/>
+</details>
+<details>
+  <summary>🌿 Mocha</summary>
+  <img src="assets/mocha.webp"/>
+</details>
+
+## Usage
+
+1. Download the file with theme (`hyprlock.conf`)
+2. Download the file with your desired flavour (e.g. `mocha.conf`) from [catppuccin/hyprland](https://github.com/catppuccin/hyprland)
+3. Copy them into your hyprland config directory (e.g. `~/.config/hypr/`)
+4. Change `source` to `/path/to/flavour.conf` (e.g. `~/.config/hypr/mocha.conf`)
+5. (optional) Change your accent color and font
+
+## 🙋 FAQ
+
+-	Q: **_"How to set user image/background?"_**\
+	A: The [hyprlock.conf](./hyprlock.conf) file is just an example config, so you may and should modify it to fit your needs.
+
+
+- Q: **_"Where can I get backgrounds from the previews?"_**\
+  A: You can find gray SVG and PNG [here](https://github.com/catppuccin/catppuccin/tree/main/assets/footers) or extract colored PNG from [Catppuccin for Vivaldi](https://github.com/catppuccin/vivaldi)
+
+## 💝 Thanks to
+
+- [NikSne](https://github.com/NikSneMC)
+
+&nbsp;
+
+<p align="center">
+	<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/footers/gray0_ctp_on_line.svg?sanitize=true" />
+</p>
+
+<p align="center">
+	Copyright &copy; 2021-present <a href="https://github.com/catppuccin" target="_blank">Catppuccin Org</a>
+</p>
+
+<p align="center">
+	<a href="https://github.com/catppuccin/catppuccin/blob/main/LICENSE"><img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&logoColor=d9e0ee&colorA=363a4f&colorB=b7bdf8"/></a>
+</p>