diff --git a/README.md b/README.md index b2ea2d5..5935a01 100644 --- a/README.md +++ b/README.md @@ -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 ``` @@ -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 - - - -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 | ❌ | + + + + ## 🔗 Dependencies @@ -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! \ No newline at end of file