Skip to content

Latest commit

 

History

History
87 lines (64 loc) · 1.96 KB

readme.md

File metadata and controls

87 lines (64 loc) · 1.96 KB
Raw

ntfy-lib

Third party ntfy API for C++.
Partial implementation of ntfy functionality as stated in https://docs.ntfy.sh/subscribe/api/

Features

  • login to ntfy server
    • baseauth
    • token
  • messages
    • sending
    • listening (async with handlers)
    • priority
    • tags
    • title
    • markdown
    • actions
    • attachments
    • UTF8 support
    • scheduled delivery

Examples

Code snippets can be found in this markdown.

Installation

See this markdown.

Documentation

Statically included markdown files can be found in doc/source/markdown.

You can generate a documentation by using doxygen.
Documentation will be written to doc/out/.

# run in project root
doxygen doc/DoxyFile

# open the documentation
# windows
start doc/out/html/index.html
# linux
open doc/out/html/index.html

Development

Building with vcpkg

  • clone with submodules to get vcpkg
  • run bootstrap and install dependencies
# run in project root or install dependecies by yourself from vcpkg.json
sh ./scripts/vcpkg_setup.sh

Toolchain-File of vcpkg is included in the CMakeLists.txt. If you don`t want to install vcpkg within this repository adjust the path accordingly. Build the library by running cmake or by running:

# run in project root
sh ./scripts/build.sh

Attributions and Licence

  • Check out ntfy.
  • This project is not affiliated to ntfy in any way.

ntfy-lib Copyright (c) 2024, parthux1 All rights reserved.

This source code is licensed under the BSD-style license found in the LICENSE file in the root directory of this source tree.