Skip to content

Commit

Permalink
doc: update readme and changelog for 0.6.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
vthib committed Apr 14, 2024
1 parent 3b9a003 commit 10b4ed4
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 3 deletions.
34 changes: 33 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,37 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.6.0] - 2024-04-14

This release mainly adds the `dotnet` module and simplifies a few dependencies.

### boreal

#### Added:

* The `dotnet` module is now available behind the `object` feature (enabled by default).
[#127](https://github.com/vthib/boreal/pull/127), [#131](https://github.com/vthib/boreal/pull/131),
[#133](https://github.com/vthib/boreal/pull/133), [#135](https://github.com/vthib/boreal/pull/135).

#### Fixed:

- Fixed compilation when using `--no-default-features` and other feature combinations.
[#129](https://github.com/vthib/boreal/pull/129), [#130](https://github.com/vthib/boreal/pull/130).
- Fixed exposure of some optional dependencies as their own features.
[#128](https://github.com/vthib/boreal/pull/128).
- Added CI jobs to ensure common combinations of features compile and run tests properly.
[#132](https://github.com/vthib/boreal/pull/132).

#### Changed:

* The `bitmap` dependency has been removed and replaced by an custom implementation for our
very limited usecase. [#120](https://github.com/vthib/boreal/pull/120).
* The `windows` dependency has been replaced by `windows-sys`.
[#137](https://github.com/vthib/boreal/pull/137).
* All dependencies have been updated to their latest versions.

Thanks to @demoray for their contributions.

## [0.5.0] - 2024-02-16

This release mainly consists of Yara 4.5 compatibility features and fixes:
Expand Down Expand Up @@ -298,7 +329,8 @@ Main changes:

Initial release.

[unreleased]: https://github.com/vthib/boreal/compare/v0.5.0...HEAD
[unreleased]: https://github.com/vthib/boreal/compare/v0.6.0...HEAD
[0.6.0]: https://github.com/vthib/boreal/compare/v0.5.0...v0.6.0
[0.5.0]: https://github.com/vthib/boreal/compare/v0.4.0...v0.5.0
[0.4.0]: https://github.com/vthib/boreal/compare/v0.3.1...v0.4.0
[0.3.1]: https://github.com/vthib/boreal/compare/v0.3.0...v0.3.1
Expand Down
4 changes: 2 additions & 2 deletions boreal/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,7 @@ free. If however someone can provide a valid use-case, this difference can be re
- [x] pe (with the _object_ feature)
- `pe.signatures` is behind the _authenticode_ feature
- `pe.imphash()` is behind the _hash_ feature
- [x] dotnet
- [x] string
- [x] time
- [x] console
Expand All @@ -124,7 +125,6 @@ Modules not yet supported:

- [ ] cuckoo
- [ ] dex
- [ ] dotnet
- [ ] magic

## Pay for what you use
Expand Down Expand Up @@ -184,7 +184,7 @@ of all signatures, imports, exports, resources, etc on every scan.

## crate feature flags

- `object`: enables the `elf`, `macho` and `pe` module.
- `object`: enables the `elf`, `macho`, `pe` and `object` module.
- `hash`: enables the `hash` module, as well as the `pe.imphash()` function if the `object`
feature is also enabled.
- `authenticode`: this enables the `signatures` part of the `pe` module. This adds
Expand Down

0 comments on commit 10b4ed4

Please sign in to comment.