update readme and ci

maxfreu · Jan 4, 2024 · 09d0c94 · 09d0c94
1 parent 5fac187
commit 09d0c94
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -3,6 +3,8 @@ on:
   push:
     branches:
       - main
+    path-ignore:
+      - "**/README.md"
     tags: ['*']
   pull_request:
   workflow_dispatch:

diff --git a/README.md b/README.md
@@ -16,4 +16,6 @@ query_result = query(tree, Extent(X=(0, 100.5), Y=(0, 1.5)))
 query_result = query(tree, query_geometry)
 ```
 
+The query result is a `Vector{Int}` that you can use to index into the collection of geometries from which the tree was created, under the assumption that it has not changed since then.
+
 Contributions are welcome! :)