aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSebastian Sellmeier <mail@sebastian-sellmeier.de>2021-07-01 18:38:54 +0200
committerSebastian Sellmeier <mail@sebastian-sellmeier.de>2021-07-01 18:38:54 +0200
commit4a95562740bee221061156110b6f60bac969eb55 (patch)
tree92c30177577a85aae212fbe8e8849cd3f34a238e
parent1c36673ecbc85bd0be8dc88249568aa8ce7f6795 (diff)
Update readme to show beta-release, rename workflow-config
-rw-r--r--.github/workflows/main.yml (renamed from .github/workflows/shellcheck.yml)2
-rw-r--r--README.md35
2 files changed, 21 insertions, 16 deletions
diff --git a/.github/workflows/shellcheck.yml b/.github/workflows/main.yml
index 48038d4..a770977 100644
--- a/.github/workflows/shellcheck.yml
+++ b/.github/workflows/main.yml
@@ -1,4 +1,4 @@
-name: ShellCheck
+name: Main
on: [push, pull_request]
diff --git a/README.md b/README.md
index bbab41f..00c21f7 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,25 @@
-# betterlockscreen
-
-> simple, minimal lockscreen
-
-Betterlockscreen allows you to cache images with different filters and lockscreen with blazing speed.
-
-## Example
-
-> lockscreen with blurred effect
-
-```sh
-betterlockscreen --lock blur
-```
+# Betterlockscreen
+> fast and sweet looking lockscreen for linux systems with effects!
+
+<div align="center">
+ <a href="https://github.com/pavanjadhaw/betterlockscreen/releases"><img alt="GitHub release (latest by date including pre-releases)" src="https://img.shields.io/github/v/release/pavanjadhaw/betterlockscreen?include_prereleases&label=latest&style=for-the-badge"></a>
+ <a href="https://github.com/pavanjadhaw/betterlockscreen/releases"><img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/pavanjadhaw/betterlockscreen?label=Stable&style=for-the-badge"></a>
+ <a href="https://github.com/pavanjadhaw/betterlockscreen/actions/workflows/main.yml?query=branch%3Amaster"><img alt="GitHub Workflow Status (master)" src="https://img.shields.io/github/workflow/status/pavanjadhaw/betterlockscreen/Main/master?label=master&style=for-the-badge"></a>
+ <a href="https://github.com/pavanjadhaw/betterlockscreen/actions/workflows/main.yml?query=branch%3Anext"><img alt="GitHub Workflow Status (next)" src="https://img.shields.io/github/workflow/status/pavanjadhaw/betterlockscreen/Main/next?label=next&style=for-the-badge"></a>
+ <a href="https://github.com/pavanjadhaw/betterlockscreen/blob/master/LICENSE"><img src="https://img.shields.io/github/license/pavanjadhaw/betterlockscreen.svg?style=for-the-badge"></a>
+</div>
+
+<div align="center">
+ <h2>You want to support us?</h2>
+
+ <a href="https://github.com/pavanjadhaw/betterlockscreen/stargazers"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/pavanjadhaw/betterlockscreen?style=social"></a>
+ <a href="https://github.com/pavanjadhaw/betterlockscreen/fork"><img alt="GitHub forks" src="https://img.shields.io/github/forks/pavanjadhaw/betterlockscreen?style=social"></a>
+ <a href="https://www.codetriage.com/pavanjadhaw/betterlockscreen"><img src="https://www.codetriage.com/pavanjadhaw/betterlockscreen/badges/users.svg"></a>
+</div>
+<br />
![scrot2](https://github.com/pavanjadhaw/betterlockscreen.demo/raw/master/scrots/scrot2.png 'scrot2.png')
-
-> [Watch some of the features of betterlockscreen in action](https://youtu.be/9Ng5FZwnn6M)
+<br />
## Table of Contents