doc

Co-Authored-By: Mostafa Kamal <[email protected]>

Author: mostafa

README.md

@@ -1,5 +1,143 @@
 
 
+# install
+
+```bash
+composer require code4mk/lara-head
+```
+
+# usage meta
+
+~ inside controller
+
+```php
+use Khead;
+class Test
+{
+  public function home()
+  {
+    Khead::setMeta('viewport',[
+      "name" => "viewport",
+      "content"=>"width=device-width, initial-scale=1"
+    ]);
+  }
+}
+```
+
+~ inside view <access>
+
+```php
+{!! Khead::getMeta('viewport') !!}
+```
+
+# link
+
+```php
+Khead::setLink('author',[
+  "rel"=>"author",
+  "href"=>"humans.txt"
+]);
+// access inside view
+
+{!! Khead::getLink('author') !!}
+```
+
+# title
+
+```php
+Khead::setTitle('this is a title');
+// access view
+{!! Khead::getTitle() !!}
+```
+
+# facebook open graph
+
+```php
+Khead::setOg([
+  "app_id" => [
+    "property"=>"fb:app_id",
+    "content"=>"123456789"
+  ],
+  "url" => [
+    "property"=>"og:url",
+    "content"=>"https://example.com/page.html"
+  ],
+  "type" => [
+    "property"=>"og:type", "content"=>"website"
+  ],
+  "title" => [
+    "property"=>"og:title",
+    "content"=>"Content Title"
+  ],
+  "image" => [
+    "property"=>"og:image",
+    "content"=>"https://example.com/image.jpg"
+  ],
+  "description" => [
+    "property"=>"og:description",
+    "content"=>"Description Here"
+  ],
+  "site_name" => [
+    "property"=>"og:site_name",
+    "content"=>"Site Name"
+  ],
+  "locale" => [
+    "property"=>"og:locale",
+    "content"=>"en_US"
+  ],
+  "author" => [
+    "property"=>"article:author",
+    "content"=>"@code4mk"
+  ]
+]);
+
+// access with view
+
+{!! Khead::getOg() !!}
+```
+
+# twitter cards
+
+```php
+Khead::setTwitCards([
+  "card" => [
+    "name" => "twitter:card",
+    "content"=>"summary"
+  ],
+  "site" => [
+    "name"=>"twitter:site",
+    "content"=>"@code4mk"
+  ],
+  "creator" => [
+    "name"=>"twitter:creator",
+    "content"=>"@code4mk"
+  ],
+  "url" => [
+    "name"=>"twitter:url",
+    "content"=>"https://code4mk.org"
+  ],
+  "title" => [
+    "name"=>"twitter:title",
+    "content"=>"Content Title"
+  ],
+  "description" => [
+    "name"=>"twitter:description",
+    "content"=>"Content description less than 200 characters"
+  ],
+  "image" => [
+    "name"=>"twitter:image",
+    "content"=>"https://code4mk.org/image.jpg"
+  ],
+  "dnt" => [
+    "name"=>"twitter:dnt",
+    "content"=>"on"
+  ]
+]);
+// access inside view
+
+{!! Khead::getTwitCards() !!}
+```
+
 
 # Head tags