Skip to content

Commit fdf1f5f

Browse files
committed
update osquery readme
1 parent 14c974f commit fdf1f5f

4 files changed

Lines changed: 54 additions & 197 deletions

File tree

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ test-codecov:
7676
.PHONY: generate_docs
7777
generate_docs: check_tools
7878
gomarkdoc -e --output '{{.Dir}}/README.md' \
79-
--exclude-dirs .,./pkg/configReader/helper,./pkg/dbcrypt/config,./pkg/openSearch/openSearchClient/config,./pkg/swagger/ginSwagger.go \
79+
--exclude-dirs .,./pkg/configReader/helper,./pkg/dbcrypt/config,./pkg/openSearch/openSearchClient/config \
8080
./...
8181

8282
check_tools:

pkg/openSearch/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ subpackages:
88
* [esextensions](esextension/README.md) - extensions for the esquery library
99
* [openSearchClient](openSearchClient/README.md) - a client for OpenSearch designed to allow easy mocking/
1010
* [openSearchQuery](openSearchQuery/README.md) - query builders for OpenSearch
11+
* [osquery](osquery/README.md) - query builders for OpenSearch (simplified version)
12+
* [ostesting](ostesting/README.md) - conveniently test against a real openSearch instance
1113

1214
# License
1315

1416
Copyright (C) 2022-2023 [Greenbone AG][Greenbone AG]
1517

1618
Licensed under the [GNU General Public License v3.0 or later](../../LICENSE).
17-
18-

0 commit comments

Comments
 (0)