Update README

[jon-sully]

Pull Request

Summary:
Still a bit WIP but wanted to pretty significantly revamp the main repo README with the V2 changes

There's still a lot more content to work on, but I at least wanted to get this up!

Related Issue:
n/a

Description:
V2 changed a lot of stuff! Felt like the whole README needed a big look and revamp ❤️

Testing:
n/a

Screenshots (if applicable):
Recommend reading from scratch instead of reading via diffs: https://github.com/jon-sully/noticed/tree/update-readme

[excid3]

Looking good so far!

[jon-sully]

One thing I'll ask for clarity on, @excid3. I don't recall if it was required or optional, but we used explicit params in my app's V1 Notifications. In V2 explicit params are totally optional and declared instead under the macro required_params (or singular required_param) instead of just params, right?

class NewCommentNotifier < Noticed::Event
  deliver_by :email do |config|
    config.mailer = "CommentMailer"
		config.if = ->(recipient) { !!recipient.preferences[:email] }
  end

  required_params :record, :foo
end

[jon-sully]

Planning on wrapping this up today, btw!

[excid3]

Sounds good. 👍

params from v1 was just renamed to required_params for clarity. They both trigger validation to check and ensure the param name was in the params hash.

[jon-sully]

I think I'm about done here! Massive changes to the README, a few tweaks to the actual library code as prompted by the README.. overall a good turnaround!

[excid3]

I'll give it a review after the kiddo goes to bed. 👍

[jon-sully]

Snuck in one more commit to add some details to the V2 upgrade guide with the more recent changes 👍