Skip to content

Commit

Permalink
Add CHANGELOG, update Cargo.toml and README for v0.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
torrancew committed Aug 4, 2024
1 parent 8d0a115 commit ece1864
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 5 deletions.
38 changes: 38 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Changelog

Starting with v0.2.0, 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.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

N/A

## [0.2.0] - 2024-08-03

### Added

- Support for custom `FieldProcessor` implementations
- Support for query expansions via the Xapian `ESet` API
- A unified `NativeRangeProcessor` that wraps upstream Xapian's built-in `RangeProcessor`
implementations

### Removed

- `DateRangeProcessor` (use `NativeRangeProcessor`)
- `NumberRangeProcessor` (use `NativeRangeProcessor`)
- `RangeProcessor` (use `NativeRangeProcessor`)

## [0.1.0] - 2024-07-09

### Added

- Initial project release
- Basic index & query support
- Support for user-provided MatchSpy and MatchDecider implementations
- Support for arbitrary types in Xapian document slots

[unreleased]: https://github.com/torrancew/xapian-rs/compare/v0.2.0...HEAD
[0.2.0]: https://github.com/torrancew/xapian-rs/compare/tag/v0.1.0...v0.2.0
[0.1.0]: https://github.com/torrancew/xapian-rs/releases/tag/v0.1.0
5 changes: 3 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
[package]
name = "xapian-rs"
version = "0.1.1-dev"
version = "0.2.0"
edition = "2021"
license = "MIT"
description = "Rust bindings for the Xapian search engine"
documentation = "https://torrancew.github.io/xapian-rs"
rust-version = "1.70"
repository = "https://github.com/torrancew/xapian-rs"
documentation = "https://torrancew.github.io/xapian-rs"

[dependencies]
autocxx = "0.27.0"
Expand Down
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
# xapian-rs

[![GitHub](https://img.shields.io/crates/l/xapian-rs)](https://github.com/torrancew/xapian-rs)
[![crates.io](https://img.shields.io/crates/d/xapian-rs)](https://crates.io/crates/xapian-rs)
[![docs.rs](https://docs.rs/xapian-rs/badge.svg)](https://docs.rs/xapian-rs)

`xapian-rs` provides a set of *low-level*, *mostly-ergonomic* Rust bindings for
the [Xapian](https://xapian.org) search library.

The bindings are provided by a mix of auto-generation (via
[`autocxx`](https://autocxx.rs)) and manually generation (via
[`autocxx`](https://autocxx.rs)) and manual generation (via
[`cxx`](https://cxx.rs)). When necessary, small C++ shims are implemented to
work around incompatibilities between these tools and the Xapian codebase.

Expand All @@ -20,9 +24,8 @@ an interesting but small subset of the capabilities of Xapian:
- Faceting

Some functionality is not provided at this time, including (but not limited to):
- `ESet`
- `RSet`
- `KeyMaker`
- Custom RangeProcessor implementations

## Design

Expand Down

0 comments on commit ece1864

Please sign in to comment.