aditya/betterlockscreen-openrc
1
0
Fork 0
mirror of https://git.adityakumar.xyz/betterlockscreen-openrc.git synced 2024-11-12 19:59:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update docs regarding master -> main change

Browse source 
(cherry picked from commit 0da7dac0f3b229e0e560706a72f23e410b468263)
This commit is contained in:
Basti 2021-10-11 17:29:23 +02:00 committed by Sebastian Sellmeier
parent 9e43994c25
commit 5d8b8aa72a
No known key found for this signature in database
GPG key ID: 51E2BE0CCC826F98
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -4,11 +4,11 @@
<div align="center"> <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 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/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%3Amain"><img alt="GitHub Workflow Status (main)" src="https://img.shields.io/github/workflow/status/pavanjadhaw/betterlockscreen/Main/main?label=main&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/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/milestone/²"><img alt="GitHub milestone" src="https://img.shields.io/github/milestones/progress/pavanjadhaw/betterlockscreen/2?style=for-the-badge"></a> <a href="https://github.com/pavanjadhaw/betterlockscreen/milestone/²"><img alt="GitHub milestone" src="https://img.shields.io/github/milestones/progress/pavanjadhaw/betterlockscreen/2?style=for-the-badge"></a>
<a href="https://github.com/pavanjadhaw/betterlockscreen/compare/v4.0.3...next"><img alt="GitHub commits since latest release (by date) for a branch" src="https://img.shields.io/github/commits-since/pavanjadhaw/betterlockscreen/v4.0.3/next?style=for-the-badge"></a> <a href="https://github.com/pavanjadhaw/betterlockscreen/compare/v4.0.3...next"><img alt="GitHub commits since latest release (by date) for a branch" src="https://img.shields.io/github/commits-since/pavanjadhaw/betterlockscreen/v4.0.3/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> <a href="https://github.com/pavanjadhaw/betterlockscreen/blob/main/LICENSE"><img src="https://img.shields.io/github/license/pavanjadhaw/betterlockscreen.svg?style=for-the-badge"></a>
</div> </div>
<div align="center"> <div align="center">
@ -78,7 +78,7 @@ If you are using **Void Linux**, you can install [betterlockscreen](https://gith
### Installation Script ### Installation Script
We have created an automatic [install-script](https://github.com/pavanjadhaw/betterlockscreen/blob/master/install.sh) for Betterlockscreen. The script is very simple and takes three parameters: We have created an automatic [install-script](https://github.com/pavanjadhaw/betterlockscreen/blob/main/install.sh) for Betterlockscreen. The script is very simple and takes three parameters:
* `<install-mode>`: (string) 'user' installs to '~/.local/bin/', 'system' installs to '/usr/local/bin' * `<install-mode>`: (string) 'user' installs to '~/.local/bin/', 'system' installs to '/usr/local/bin'
* `[<version>]`: (string) defaults to 'latest' which will determinate the latest tag from git or specified branch/tag * `[<version>]`: (string) defaults to 'latest' which will determinate the latest tag from git or specified branch/tag
* `[<systemd-service>]`: (boolean) defaults to 'false' - Whether to copy and enable system-service. * `[<systemd-service>]`: (boolean) defaults to 'false' - Whether to copy and enable system-service.
@ -93,7 +93,7 @@ For user-installation:
wget https://git.io/JZyxV -O - -q | bash -- user wget https://git.io/JZyxV -O - -q | bash -- user
``` ```
Please note: The [git.io](https://git.io/)-URL is just a short-url for the [master/install.sh](https://raw.githubusercontent.com/pavanjadhaw/betterlockscreen/master/install.sh). Please note: The [git.io](https://git.io/)-URL is just a short-url for the [main/install.sh](https://raw.githubusercontent.com/pavanjadhaw/betterlockscreen/main/install.sh).
### Manual Installation ### Manual Installation
@ -103,10 +103,10 @@ You will need to copy "betterlockscreen" to you desired binary-directory, if you
Example (Ubuntu): Example (Ubuntu):
```sh ```sh
wget https://github.com/pavanjadhaw/betterlockscreen/archive/refs/heads/master.zip wget https://github.com/pavanjadhaw/betterlockscreen/archive/refs/heads/main.zip
unzip master.zip unzip main.zip
cd betterlockscreen-master/ cd betterlockscreen-main/
chmod u+x betterlockscreen chmod u+x betterlockscreen
cp betterlockscreen /usr/local/bin/ cp betterlockscreen /usr/local/bin/
@ -275,7 +275,7 @@ Please see [CONTRIBUTING.md](CONTRIBUTING.md).
## License ## License
Betterlockscreen is under [MIT](https://github.com/pavanjadhaw/betterlockscreen/blob/master/LICENSE) license. Betterlockscreen is under [MIT](https://github.com/pavanjadhaw/betterlockscreen/blob/main/LICENSE) license.
### Feel free to use and distribute ### Feel free to use and distribute