Skip to content

Commit

Permalink
Merge branch 'main' into net-http
Browse files Browse the repository at this point in the history
  • Loading branch information
p-samuel committed Mar 26, 2023
2 parents 89b8870 + 5280f2c commit 114f21e
Showing 1 changed file with 10 additions and 25 deletions.
35 changes: 10 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ You need to add ```src``` folder to your library path or search path.

## ⚙️ Boss Installation

Boss is a dependecy manager for Delphi created by [Hashload](https://github.com/HashLoad) community.

```
boss install github.com/hazzelnuts/ntfy-for-delphi
```
Expand Down Expand Up @@ -58,31 +60,14 @@ end;
```

There is a [VCL Sample](https://github.com/p-samuel/delphi-notify/tree/main/sample/vcl) demonstration showing you how to use Delphi Ntfy subscription mechanism into your project.
There is a [VCL Sample](https://github.com/p-samuel/delphi-notify/tree/main/sample/vcl) demonstration showing you how to utilize the subscription mechanism into your project.

## ⚙️ Supported Version & Platforms

<img src="https://img.shields.io/badge/Delphi%20Supported%20Version%20-v10.1%2B%20-blue"></img>
<img src="https://img.shields.io/badge/Supported%20Platforms-Win32%20%26%20Win64-green"></img>

It hasn't been tested in some Delphi versions yet. You can help finding out informing with a PR update to this README file. In the PR, inform the selected badged.

## ⛔ Limitations

Support to notifications that contains ```broadcast``` actions has not been implemented. Likewise, some advanced specific resources has not yet been implemented as well.

| Action | Support |
|-------------|:--------:|
| view ||
| broadcast ||
| http ||

| Subscription Type | Support |
|-------------------------|:---------:|
| json ||
| raw ||
| sse ||
| websocket ||
<img src="https://img.shields.io/badge/Delphi%20-v10.1%2B%20-blue"></img>
<img src="https://img.shields.io/badge/Windows-32%20%26%2064%20bits-green"></img>
<img src="https://img.shields.io/badge/Android-gray"></img>
<img src="https://img.shields.io/badge/IOS-gray"></img>

## 🔗 Dependencies

Expand All @@ -93,11 +78,11 @@ Ntfy for Delphi uses a few libraries in the messages subscription and publishing
* [NetHTTP](https://docwiki.embarcadero.com/RADStudio/Rio/en/Using_an_HTTP_Client) native components.
* [Indy10](https://github.com/IndySockets/Indy) by IndySockets. (optional)

## ♻ Switching between NetHTTP and Indy

The library's default behavior is to use NetHTTP for managing the HTTP communications. However, if you are like to use Indy over NetHTTP, you can go to `Project > Options > Building > Delphi Compiler > Conditional Defines` and add `NTFY_HTTP_INDY` in the conditional defines list.
## 📚 Wiki

Check out the [wiki](https://github.com/hazzelnuts/ntfy-for-delphi/wiki) page for specific instructions or tutorials.

## 🌱 Consider Contributing

Ntfy for Delphi it's an open source project under the MIT license. Feel free to use or contribute!
Ntfy for Delphi it's an open source project under the MIT license. Feel free to use or contribute!

0 comments on commit 114f21e

Please sign in to comment.