Skip to content

Commit

Permalink
chore: add bechmark result on the README
Browse files Browse the repository at this point in the history
  • Loading branch information
GokselKUCUKSAHIN committed Jun 4, 2024
1 parent 728b060 commit 8ea43a8
Showing 1 changed file with 26 additions and 3 deletions.
29 changes: 26 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# es-query-builder [![GoDoc][doc-img]][doc] [![Build Status][ci-img]][ci] [![Go Report Card][go-report-img]][go-report] [![Coverage Status][cov-img]][cov]
A Simple query builder for Elasticsearch

## How to get?
```bash
go get github.com/GokselKUCUKSAHIN/es-query-builder
```

## Project
- [ ] improve README
- [x] add examples
- [ ] add benchmark results
- [x] add benchmark results
- [x] add `go get` command
- [x] add badges
- [x] setup github workflow
Expand Down Expand Up @@ -40,8 +41,6 @@ go get github.com/GokselKUCUKSAHIN/es-query-builder

### Examples

# 🚧 Still under construction 🚧

```json
{
"query": {
Expand Down Expand Up @@ -132,6 +131,30 @@ query := es.NewQuery(
)
```

# Benchmarks
You can check and run [benchmarks](./benchmarks) on your machine.

### ARMv6l
- **Device** Raspberry Pi Zero W
- **CPU**: Broadcom BCM2835 1GHz 1 Core
- **Arch**: ARM v6 32 bit
- **Memory**: 512MB LPDDR2
- **Go Version**: go1.22.3

![armv6l](https://github.com/GokselKUCUKSAHIN/es-query-builder/assets/33639948/8972003d-9b00-4021-9f69-347723ac59de)

### ARM64
- **Device** MacBook Pro 16" 2021
- **CPU**: Apple Silicon M1 Pro 10 Core
- **Arch**: ARM64
- **Memory**: 32GB LPDDR5
- **Go Version**: go1.22.1

![arm64](https://github.com/GokselKUCUKSAHIN/es-query-builder/assets/33639948/ca9e2603-ebcd-4dec-92f4-e501ddcc4abe)

# License
MIT - Please check the [LICENSE](./LICENSE) file for full text.

[doc-img]: https://godoc.org/github.com/GokselKUCUKSAHIN/es-query-builder?status.svg
[doc]: https://godoc.org/github.com/GokselKUCUKSAHIN/es-query-builder
[go-report-img]: https://goreportcard.com/badge/github.com/GokselKUCUKSAHIN/es-query-builder
Expand Down

0 comments on commit 8ea43a8

Please sign in to comment.