Skip to content

Commit

Permalink
doc tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
dakujem committed Jan 19, 2024
1 parent 50439b7 commit 9965f5e
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 6 deletions.
12 changes: 12 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@

# Changelog

> 📖 back to [readme](readme.md)
Oliva follows semantic versioning.\
Please report any issues.


## v1.0

The initial release.
12 changes: 6 additions & 6 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# 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)


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
Expand Down Expand Up @@ -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.

Expand Down

0 comments on commit 9965f5e

Please sign in to comment.