Add README

ezitisitis · Feb 12, 2023 · ea0ecec · ea0ecec
1 parent a23047e
commit ea0ecec
Showing 1 changed file with 31 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,31 @@
+# Laravel social trackers
+
+## Install
+
+First of all- install package.
+
+```bash
+composer require ezitisitis/laravel-social-trackers
+```
+
+Now populate `services` config with config values:
+
+```php
+'google_tag_manager_id' => env('GOOGLE_TAG_MANAGER_ID'),
+```
+
+## Usage
+
+Simply put `Tracker::your_desired_tracker` to the `head` section. For example:
+
+```blade
+<head>
+    ...
+    {{\Ezitisitis\LaravelTracking\Tracker::googleTagManager()}}
+    ...
+</head>
+<body>
+    {{\Ezitisitis\LaravelTracking\Tracker::googleTagManagerNoScript()}}
+    ...
+</body>
+```