Skip to content

Commit

Permalink
add better description to the gem
Browse files Browse the repository at this point in the history
  • Loading branch information
marcosgz committed Sep 21, 2023
1 parent 30cd1fa commit fd96df5
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

[![build](https://github.com/marcosgz/esse/actions/workflows/build.yml/badge.svg)](https://github.com/marcosgz/esse/actions/workflows/build.yml)

This gem is a Ruby simple and extremely flexible client for ElasticSearch and OpenSearch based on official clients such as [elasticsearch-ruby](https://github.com/elastic/elasticsearch-ruby) and [opensearch-ruby](https://github.com/opensearch-project/opensearch-ruby). It's a pure Ruby implementation, and due to its modular design, it's easy to extend and adapt to your needs. Esse extensions are available as separate gems. A few examples:
This gem is a Ruby simple and extremely flexible client for ElasticSearch and OpenSearch based on official clients such as [elasticsearch-ruby](https://github.com/elastic/elasticsearch-ruby) and [opensearch-ruby](https://github.com/opensearch-project/opensearch-ruby). It's a pure Ruby implementation, framework agnostic, and due to its modular design, it's easy to extend and adapt to your needs. Esse extensions are available as separate gems. A few examples:

- [esse-kaminari](https://github.com/marcosgz/esse-kaminari) - Kaminari pagination support
- **WIP** [esse-rails](https://github.com/marcosgz/esse-rails) - Ruby on Rails integration. It also includes the active_record extension below by default with a few extra features.
Expand Down
8 changes: 5 additions & 3 deletions esse.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,11 @@ Gem::Specification.new do |spec|
spec.authors = ['Marcos G. Zimmermann']
spec.email = ['mgzmaster@gmail.com']

spec.summary = %[Pure Ruby toolkit based on official elasticsearch-ruby library. (No! It isn't a new DSL)]
spec.description = 'All the elegance of ruby with the elasticsearch flexibility. This gem is a pretty simple ' \
'but excential helpers to deal with mapping, indexing, serialization and search.'
spec.summary = %[Pure Ruby and framework-agnostic ElasticSearch/OpenSearch toolkit for building indexers and searchers]
spec.description = 'With all elegance of Ruby and ElasticSearch flexibility this gem brings to you the best of both ' \
'worlds. Provides a solid architecture allowing to easily Extract, Transform, Enrich and Load ' \
'data from any data source into ElasticSearch/OpenSearch and also to search it. It is framework-agnostic, ' \
'which means you can use it with any Ruby framework or even without any framework at all.' \
spec.homepage = 'https://github.com/marcosgz/esse'
spec.license = 'MIT'
spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
Expand Down

0 comments on commit fd96df5

Please sign in to comment.