Skip to content

Commit e01de8a

Browse files
committed
docs(readme): update header indentation
1 parent f7e0f96 commit e01de8a

1 file changed

Lines changed: 22 additions & 18 deletions

File tree

README.md

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,11 @@ This library is packaged with [ntfy-desktop](https://github.com/Aetherinox/ntfy-
1717
<div align="center">
1818

1919
<!-- prettier-ignore-start -->
20-
[![Version][badge-version-gh]][link-version-gh] [![Build Status][badge-build]][link-build] [![Downloads][badge-downloads-gh]][link-downloads-gh] [![Size][badge-size-gh]][badge-size-gh] [![Last Commit][badge-commit]][badge-commit]
20+
[![Version][badge-version-gh]][link-version-gh]
21+
[![Build Status][badge-build]][link-build]
22+
[![Downloads][badge-downloads-gh]][link-downloads-gh]
23+
[![Size][badge-size-gh]][badge-size-gh]
24+
[![Last Commit][badge-commit]][badge-commit]
2125
<!-- prettier-ignore-end -->
2226

2327
</div>
@@ -67,14 +71,14 @@ This library is packaged with [ntfy-desktop](https://github.com/Aetherinox/ntfy-
6771
- [appID support](#appid-support)
6872
- [Create App Shortcut](#create-app-shortcut)
6973
- [Call App](#call-app)
70-
- [Help](#help)
71-
- [How to change text `NtfyToast` at the top of notifications](#how-to-change-text-ntfytoast-at-the-top-of-notifications)
72-
- [Can't use Windows Toast notifications in WSL2](#cant-use-windows-toast-notifications-in-wsl2)
73-
- [Distributing with Electron](#distributing-with-electron)
74-
- [Using Webpack](#using-webpack)
75-
- [Windows: Where are files / .lnk files placed](#windows-where-are-files--lnk-files-placed)
76-
- [Header icon broken / missing / default](#header-icon-broken--missing--default)
77-
- [Usage in tmux session](#usage-in-tmux-session)
74+
- [Help](#help)
75+
- [How to change text `NtfyToast` at the top of notifications](#how-to-change-text-ntfytoast-at-the-top-of-notifications)
76+
- [Can't use Windows Toast notifications in WSL2](#cant-use-windows-toast-notifications-in-wsl2)
77+
- [Distributing with Electron](#distributing-with-electron)
78+
- [Using Webpack](#using-webpack)
79+
- [Windows: Where are files / .lnk files placed](#windows-where-are-files--lnk-files-placed)
80+
- [Header icon broken / missing / default](#header-icon-broken--missing--default)
81+
- [Usage in tmux session](#usage-in-tmux-session)
7882

7983
<br />
8084

@@ -242,7 +246,7 @@ const WindowsBalloon = require('toasted-notifier/notifiers/balloon');
242246
new WindowsBalloon(options).notify();
243247

244248
/*
245-
send notification to users running Windows or macOS users.
249+
send notification to users running Windows or macOS
246250
this is the fallback used if the above notification vendors aren't available.
247251
*/
248252

@@ -782,21 +786,21 @@ With the above code, we have specified an `appID` on the following line:
782786

783787
<br />
784788

785-
## Help
789+
# Help
786790

787791
The following is a list of questions or troubleshooting that may help you with implementing this node package.
788792

789793
<br />
790794

791-
### How to change text `NtfyToast` at the top of notifications
795+
## How to change text `NtfyToast` at the top of notifications
792796

793797
In order to change the text `NtfyToast`, you must supply an `-appID`. Windows Toast notifications require that you provide an application id for a valid Windows application before Windows will allow you to link another program.
794798

795799
For instructions on accomplishing this, read the section [appID support](#appid-support)
796800

797801
<br />
798802

799-
### Can't use Windows Toast notifications in WSL2
803+
## Can't use Windows Toast notifications in WSL2
800804

801805
Ntfy makes use of a 3rd party package for Windows notifications to work. You must change the permissions on the Ntfy vendor .exe in order for it to work properly.
802806

@@ -816,7 +820,7 @@ You can add a `postinstall` action in the `package.json`:
816820
817821
<br />
818822
819-
### Distributing with Electron
823+
## Distributing with Electron
820824
821825
If you package your Electron based app as an asar; toasted-notifier will fail to load. This is because of how a asar package works. You cannot execute a binary from within an asar package.
822826
@@ -844,7 +848,7 @@ build: {
844848
845849
<br />
846850
847-
### Using Webpack
851+
## Using Webpack
848852
849853
When using `toasted-notifier` inside of webpack, you must add the snippet below to your `webpack.config.js`.
850854
@@ -859,7 +863,7 @@ This is necessary because toasted-notifier loads the notifiers from a binary, an
859863

860864
<br />
861865

862-
### Windows: Where are files / .lnk files placed
866+
## Windows: Where are files / .lnk files placed
863867

864868
In order for you to make your own custom application name appear at the top of a notification, you must create a `.lnk` in your Windows start menu. More about this is outlined in the section [AppID Support](#appid-support)
865869

@@ -880,7 +884,7 @@ Delete any folders named `NtfyToast`, or whatever your custom app name is.
880884

881885
<br />
882886

883-
### Header icon broken / missing / default
887+
## Header icon broken / missing / default
884888
If you show a notification and notice that the far top-left icon next to the app name is either missing or is showing a default application icon, you may need to clear your start menu `.lnk` file.
885889

886890
<br />
@@ -895,7 +899,7 @@ If you are using a custom application, search for the app name as a folder, and
895899

896900
<br />
897901

898-
### Usage in tmux session
902+
## Usage in tmux session
899903

900904
When using toasted-notifier within a tmux session, it can cause the system to abruptly hang. To solve this issue:
901905

0 commit comments

Comments
 (0)