From 9965f5e3ffc381ba2d55d38ede89823c84803a73 Mon Sep 17 00:00:00 2001 From: Andrej Rypo Date: Fri, 19 Jan 2024 22:21:47 +0100 Subject: [PATCH] doc tweaks --- changelog.md | 12 ++++++++++++ readme.md | 12 ++++++------ 2 files changed, 18 insertions(+), 6 deletions(-) create mode 100644 changelog.md diff --git a/changelog.md b/changelog.md new file mode 100644 index 0000000..bd096bb --- /dev/null +++ b/changelog.md @@ -0,0 +1,12 @@ + +# Changelog + +> 📖 back to [readme](readme.md) + +Oliva follows semantic versioning.\ +Please report any issues. + + +## v1.0 + +The initial release. diff --git a/readme.md b/readme.md index a27539d..34ec82c 100644 --- a/readme.md +++ b/readme.md @@ -1,4 +1,5 @@ -# Oliva + +# Oliva 🌳 [![Test Suite](https://github.com/dakujem/oliva/actions/workflows/php-test.yml/badge.svg)](https://github.com/dakujem/oliva/actions/workflows/php-test.yml) [![Coverage Status](https://coveralls.io/repos/github/dakujem/oliva/badge.svg?branch=trunk)](https://coveralls.io/github/dakujem/oliva?branch=trunk) @@ -6,15 +7,14 @@ Flexible tree structure, tree builders (materialized path trees, recursive trees), -tree traversal iterators, -filter iterator. +tree traversal iterators, filter iterator. > > 💿 `composer require dakujem/oliva` > -This package is a modern reimplementation of [`oliva/tree`](https://github.com/dakujem/oliva-tree). +This package is a modern reimplementation of [`oliva/tree`](https://packagist.org/packages/oliva/tree). ## Tree @@ -587,8 +587,8 @@ If a node's parent matches the value, it is considered the root node. **Builders and iterators** If migrating from the previous library ([`oliva/tree`](https://github.com/dakujem/oliva-tree)), the most common problems are caused by -- the builders not automatically adding an empty root node -- the iterators iterating over root node +- the new builders not automatically adding an empty root node +- the new iterators iterating over root node For both, see "Materialized path tree without root data" and "Recursive tree without root data" sections above.