Skip to content

Commit

Permalink
feat: Improve README and description
Browse files Browse the repository at this point in the history
  • Loading branch information
jurf committed Jul 12, 2023
1 parent 1c3ccde commit 3359711
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 5 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@
[![ESLint](https://github.com/jurf/gnome-kmonad-toggle/actions/workflows/eslint.yml/badge.svg)](https://github.com/jurf/gnome-kmonad-toggle/actions/workflows/eslint.yml)
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/L4L4J6WSK)

# KMonad Toggle GNOME Shell Extension
# KMonad Toggle GNOME Shell Extension [![ESLint](https://github.com/jurf/gnome-kmonad-toggle/actions/workflows/eslint.yml/badge.svg)](https://github.com/jurf/gnome-kmonad-toggle/actions/workflows/eslint.yml)

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/L4L4J6WSK)
Control KMonad directly from GNOME Shell!

This extension allows you to:

- Autostart KMonad on login
- Quickly check if KMonad is running from the top bar
- Toggle KMonad on or off with a quick setting
- Easily configure the KMonad launch command

GNOME Shell extension for adding a KMonad toggle quick setting and indicator. Allows you to control KMonad directly from GNOME Shell.
**Note**: This extension does not manage the KMonad installation. See the [Installation guide][kmonad-installation] and [FAQ][kmonad-faq] for instructions on how to set it up.

## Installation

Expand All @@ -18,3 +25,5 @@ gnome-extensions install --force [email protected]
```

[ego]: https://extensions.gnome.org/extension/6069/kmonad-toggle/
[kmonad-installation]: https://github.com/kmonad/kmonad/blob/master/doc/installation.md
[kmonad-faq]: https://github.com/kmonad/kmonad/blob/master/doc/faq.md
2 changes: 1 addition & 1 deletion metadata.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "KMonad Toggle",
"description": "Adds a KMonad toggle quick setting and indicator",
"description": "Control KMonad directly from GNOME Shell!",
"uuid": "[email protected]",
"shell-version": ["44"],
"settings-schema": "org.gnome.shell.extensions.kmonad-toggle",
Expand Down

0 comments on commit 3359711

Please sign in to comment.