Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
esmarkowski committed Mar 6, 2024
1 parent 0d5b148 commit 8e80223
Showing 1 changed file with 21 additions and 10 deletions.
31 changes: 21 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,16 +98,6 @@ Model.bulk_in_batches(records, size: 100) do |batch|
end
```


## Instrumentation
```ruby
Blanket.first
```

```sh
Blanket (6.322ms) curl -X GET 'http://localhost:9200/blankets/_search?size=1' -d '{"sort":{"date":"desc"}}'
```

## Installation

Install the gem and add to the application's Gemfile by executing:
Expand All @@ -131,6 +121,12 @@ rails credentials:edit
```yaml
elasticsearch:
url: localhost:9200

# or opensearch
# opensearch:
# host: https://localhost:9200
# user: admin
# password: admin
```

#### Create an initializer
Expand All @@ -154,6 +150,21 @@ After checking out the repo, run `bin/setup` to install dependencies. You can al
> Full documentation on [Elasticsearch Query DSL and Aggregation options](https://github.com/elastic/elasticsearch-rails/tree/main/elasticsearch-persistence)
## Testing
<details>
<summary>Act</summary>

Run github action workflow locally

```sh
brew install act --HEAD
```

```sh
act -P ubuntu-latest=ghcr.io/catthehacker/ubuntu:runner-latest
```

</details>

<details>
<summary>Elasticsearch</summary>

Expand Down

0 comments on commit 8e80223

Please sign in to comment.