update readme

nkwtnb · Mar 7, 2022 · b983427 · b983427
1 parent a976d46
commit b983427
Showing 1 changed file with 24 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,25 @@
 # OGParser
+This is a library for get OGP.
+
+## Install
+```
+$ composer require nkwtnb/ogparser
+```
+
+## Usage
+```
+<?php
+use nkwtnb\ogparser\Ogparser;
+
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$ogp = new Ogparser("https://example.com");
+var_dump($ogp->get_url());
+var_dump($ogp->get_title());
+var_dump($ogp->get_description());
+var_dump($ogp->get_image());
+var_dump($ogp->get_site_name());
+```
+
+## License
+MIT