opensearch-project / opensearch-php

Official PHP Client for OpenSearch

Other

110 stars 58 forks source link

Added sample code to readme.md #103

Closed harrowmykel closed 2 years ago

harrowmykel commented 2 years ago

Description

This change adds a sample code to readme so that developers can easily get started

Issues Resolved

Closes #27 #46

dblock commented 2 years ago

We have been writing https://github.com/opensearch-project/opensearch-php/blob/main/USER_GUIDE.md - is this duplicate? Maybe the README needs to be clearer to look there for sample code? I also think sample code should be runnable, or exercised in CI, and we would point to a working code, ideally.

harrowmykel commented 2 years ago

Yes, please add the link to the readme.md. I didn't see the sample codes.

Also I have more examples in my sample code. You can add them.

harrowmykel commented 2 years ago

I have updated it and added a new commit

dblock commented 2 years ago

@harrowmykel LGTM, please fix DCO with (git commit -s --amend)?

codecov-commenter commented 2 years ago

Codecov Report

:exclamation: No coverage uploaded for pull request base (main@cf91bd8). Click here to learn what that means. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #103   +/-   ##
=======================================
  Coverage        ?   26.96%           
  Complexity      ?     1934           
=======================================
  Files           ?      245           
  Lines           ?     5544           
  Branches        ?        0           
=======================================
  Hits            ?     1495           
  Misses          ?     4049           
  Partials        ?        0

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

harrowmykel commented 2 years ago

Ok. i have done that

shyim commented 2 years ago

@harrowmykel You have to sign all your commits or squash into one