Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update references to scripts and plugins directories in readme #4

Merged
merged 1 commit into from
Aug 31, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 21 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,29 @@ Using IPC enables each plugin to isolate their data from other plugin processes

## Plugin Directories

- User-local plugins: `~/.local/share/pop-shell/plugins`
- System-wide install for system administrators: `/etc/pop-shell/plugins`
- Distribution packaging: `/usr/lib/pop-shell/plugins`
- User-local plugins: `~/.local/share/pop-launcher/plugins`
- System-wide install for system administrators: `/etc/pop-launcher/plugins`
- Distribution packaging: `/usr/lib/pop-launcher/plugins`

## Script Directories

- User-local scripts: `~/.local/share/pop-shell/scripts`
- System-wide install for system administrators: `/etc/pop-shell/scripts`
- Distribution packaging: `/usr/lib/pop-shell/scripts`
- User-local scripts: `~/.local/share/pop-launcher/scripts`
- System-wide install for system administrators: `/etc/pop-launcher/scripts`
- Distribution packaging: `/usr/lib/pop-launcher/scripts`

Example script
<details>
<pre>
#!/bin/sh
#
# name: Connect to VPN
# icon: network-vpn
# description: Start VPN
# keywords: vpn start connect

nmcli connection up "vpn-name"
</pre>
</details>

## JSON IPC

Expand Down Expand Up @@ -182,4 +196,4 @@ Where `SearchResult` is:
category_icon?: IconSource,
window?: [number, number]
}
```
```