search

novuhq / novu-ruby

Ruby SDK for Novu - The open-source notification infrastructure for engineers. 🚀
https://rubygems.org/gems/novu
MIT License
23 stars 10 forks source link

Docs: Update Readme with code snippets examples for all the API methods #28

Closed unicodeveloper closed 1 year ago

unicodeveloper commented 1 year ago

Right now, we have the methods documented in the readme. However, it's not comprehensive enough. It doesn't show examples of the parameters that should be passed in for each of the methods.

A very good comprehensive readme is that of the Novu PHP SDK.

We need the Ruby Readme to be this comprehensive so that users can easily copy/paste code snippet into their codebase.

Screenshot 2023-07-06 at 23 59 16 Screenshot 2023-07-06 at 23 59 29

Eazybright commented 1 year ago

@unicodeveloper this should be fun!

unicodeveloper commented 1 year ago

Oh yes! Do you want to take on this one? @Eazybright

Eazybright commented 1 year ago

yes

unicodeveloper commented 1 year ago

Done.

Eazybright commented 1 year ago

@unicodeveloper PR is open for this issue: https://github.com/novuhq/novu-ruby/pull/29

unicodeveloper commented 1 year ago

Thanks, I'll review it tomorrow @Eazybright

unicodeveloper commented 1 year ago

Done. So I'll close this now.