parra/ntfy
parra/ntfy
1
0
Fork 0
mirror of https://github.com/binwiederhier/ntfy.git synced 2024-11-25 20:59:36 +01:00
Code Releases Activity

Update readme

Browse source
This commit is contained in:
Philipp Heckel 2021-11-20 16:02:05 -05:00
parent 45f94ead8b
commit e3bc92e158
1 changed files with 15 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -2,7 +2,7 @@
# ntfy.sh | simple HTTP-based pub-sub
**Ntfy** (pronounce: *notify*) is a simple HTTP-based [pub-sub](https://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern) notification service.
**ntfy** (pronounce: *notify*) is a simple HTTP-based [pub-sub](https://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern) notification service.
It allows you to **send notifications to your phone or desktop via scripts** from any computer, entirely **without signup or cost**.
It's also open source (as you can plainly see) if you want to run your own.
@ -155,15 +155,27 @@ docker run --rm -it binwiederhier/ntfy
go get -u heckel.io/ntfy
```
**Manual install** (*any x86_64-based Linux*)**:**
**Manual install:**
```bash
# x86_64/amd64
wget https://github.com/binwiederhier/ntfy/releases/download/v1.4.5/ntfy_1.4.5_linux_x86_64.tar.gz
# ARMv6
wget https://github.com/binwiederhier/ntfy/releases/download/v1.4.5/ntfy_1.4.5_linux_armv6.tar.gz
# ARMv7
wget https://github.com/binwiederhier/ntfy/releases/download/v1.4.5/ntfy_1.4.5_linux_armv7.tar.gz
# arm64
wget https://github.com/binwiederhier/ntfy/releases/download/v1.4.5/ntfy_1.4.5_linux_arm64.tar.gz
# Extract and run
sudo tar -C /usr/bin -zxf ntfy_1.4.5_linux_x86_64.tar.gz ntfy
./ntfy
```
## Building
Building ntfy is simple. Here's how you do it:
Building `ntfy` is simple. Here's how you do it:
```
make build-simple
@ -173,9 +185,6 @@ make build-simple
To build releases, I use [GoReleaser](https://goreleaser.com/). If you have that installed, you can run `make build` or
`make build-snapshot`.
## TODO
- add HTTPS
## Contributing
I welcome any and all contributions. Just create a PR or an issue.