Don't nest custom properties under a "properties" key in docs

[axelson]

When I tested integrating this, if I call capture with my custom properties nested under a properties key like:

Posthog.capture("purchase", [
  distinct_id: "user_123",
  properties: %{
    product_id: "prod_123",
    price: 99.99
  }
])

Then all my values are nested in Posthog which means I cannot filter on individual properties.

So instead it seems more appropriate to directly send each property at the top-level like:

Posthog.capture("purchase", [
  distinct_id: "user_123",
  product_id: "prod_123",
  price: 99.99
])

And that also matches the format in the example for Posthog.Client.build_event/2

[rafaeelaudibert]

Yikes, you are right, this was a mistake. The intention here was to follow closely what our other backend libraries do, and this is a change in behavior.

Namely, posthog-node works like this:

posthog.capture({ distinct_id: "user_123", event: "event_name", properties: { ... } })

I like how we have the event name as a separate property, but it'd have been ideal if we had captured distinctId separately.

I'll create a mega issue with suggested changes for v2 and include this there.

In the meantime, I agree this is a needed fix in the docs. Thank you so much! I'll be merging this now, but wont release a new version until we get your other PR to merge to avoid a lot of dummy versions

Thank you!