Skip to content

Commit

Permalink
Updated README and CHANGELOG
Browse files Browse the repository at this point in the history
  • Loading branch information
fpagliughi committed Jan 3, 2025
1 parent 5629f89 commit 4eebc8d
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 26 deletions.
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
## Version 1.5.0 (Unreleased)

- Required C++ standard raised to C++17
- CMake minimum required version raised to v3.12
- CMake minimum required version raised to v3.12
- Clients always created for v5 persistence format, making it universal for any connection.
- If the application specifies a version it is kept as a hint for default connections.
- The version for the connection should be specified in the connect options.
Expand All @@ -26,12 +26,16 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
- `property` can now report the `typeid` of its contained value.
- The `properties` list implements a const iterator
- Added a `to_string()` and `operator<<()` for reason codes.
- `thread_queue` is now closable.
- Removed the manual implementation of `make_unique<>()`
- Added `create_options` assignment operators.
- Cleaned up and fixed a number of example apps.
- Most apps now except a server URI from the command line
- 'data_publish' example uses C++17 std::filesystem for creating a file-based encrypted persistence for messages.
- Reorganized the source repository
- Completely reformat the sources and added a .clang-format file (a project master and a slightly-different one for headers).
- Added GitHub CI Action, removing legacy Travis and Appveyor files
- [#503](https://github.com/eclipse-paho/paho.mqtt.cpp/issues/503) Fixed issue that generated docs were empty.


## [Version 1.4.1](https://github.com/eclipse/paho.mqtt.cpp/compare/v1.4.0..v1.4.1) - (2024-07-09)
Expand Down
37 changes: 12 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,31 +33,18 @@ To keep up with the latest announcements for this project, or to ask questions:

**Email:** [Eclipse Paho Mailing List](https://accounts.eclipse.org/mailing-list/paho-dev)

### Unreleased Features in This Branch

- Required C++ standard raised to C++17
- CMake minimum required version raised to v3.12
- Reformat the sources and added a .clang-format file (a project master and a slightly-different one for headers).
- Clients always created for v5 persistence format, making it universal for any connection.
- If the application specifies a version it is kept as a hint for default connections.
- The version for the connection should be specified in the connect options.


### What's New in v1.4.x

The v1.4 releases were primarily concerned with reorganizing the sources and fixing a number of CMake build issues, particularly to get the Paho C submodule build working with the existing C library. They also fixed some transient build dependencies and may have finally gotten the Windows DLL working properly.

- Ability to build the Paho C library automatically (now working!)
- Reworked the CMake build so that 'PAHO_WITH_MQTT_C' option properly compiles the existing Paho C v1.3.13
- Moved 'src/externals/' to top-level
- Reorganized the source tree:
- Moved header files to top-level 'include/' directory.
- Moved 'src/sampless/' to top-level and renamed 'examples/'
- Fixed and optimized 'topic_matcher' trie collection
- Added some missing Eclipse/Paho legal documents to the repo.
- Several bug fixes.

For a full list of updates see the [CHANGELOG](https://github.com/eclipse/paho.mqtt.cpp/blob/master/CHANGELOG.md)
### Working toward Release v1.5

The work toward Version 1.5 is underway, and should be released in early 2025. The features will include:

- Update the code base to C++17
- Support for the pending Paho C v1.3.14 release.
- Support for UNIX-domain sockets
- Reorganize and reformat the sources and added a .clang-format capability.
- Create universal client instances that can connect using v3 or v5. (i.e. no more instances that are only v3 capable)
- Bump the CMake to v3.12
- Fix a number of CMake build issues
- Update the GitHub CI

## Contributing

Expand Down

0 comments on commit 4eebc8d

Please sign in to comment.