diff --git a/README.md b/README.md index 16977d1..23b6072 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,3 @@ - # SherpaJS Events ![NPM Version](https://img.shields.io/npm/v/sherpajs-events) @@ -8,17 +7,27 @@ using [Metadapter Event](https://github.com/sellersindustry/metadapter-event) an modular serverless platform. +
+ ## Features - ✅ [SherpaJS](https://github.com/sellersindustry/SherpaJS) Module, an Agnostic and Modular Serverless Platform - ✅ Log event using [Metadapter Event](https://github.com/sellersindustry/metadapter-event) - ✅ Supports PostHog + +
+ + ## Installation ``` npm install sherpajs-events ``` + +
+ + ## Example Usage Services are loaded using [Metadapter Event](https://github.com/sellersindustry/metadapter-event). The `id` is the eventID that is logged with your event platform. The `schema` is optional, but uses [AJV schema](https://ajv.js.org/). ```typescript