Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
romanzipp committed Apr 4, 2019
1 parent 0178a0c commit 3608cc0
Showing 1 changed file with 64 additions and 16 deletions.
80 changes: 64 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,55 +61,103 @@ class IndexController

### Examples

#### Title

```php
use romanzipp\Seo\Structs\Title;
use romanzipp\Seo\Structs\Meta\Charset;
use romanzipp\Seo\Structs\Meta\Twitter;
use romanzipp\Seo\Structs\Meta\OpenGraph;
```

seo()->add(Title::make()->body('romanzipp'));
```
```php
// <title>romanzipp</title>
seo()->title('romanzipp');
```

seo()->add(Title::make()->body('romanzipp'));
... both compile to ...

seo()->title('romanzipp');
```html
<title>romanzipp</title>
```

#### Charset

```php
// <meta charset="utf-8" />
use romanzipp\Seo\Structs\Meta\Charset;

seo()->add(new Charset);
```

```php
use romanzipp\Seo\Structs\Meta\Charset;

seo()->add(Charset::make());
```

```php
use romanzipp\Seo\Structs\Meta\Charset;

seo()->add(Charset::make()->charset('utf-8'));
```

seo()->add(new Charset);
... all compile to ...

```html
<meta charset="utf-8" />
```

```php
// <meta name="twitter:card" content="summary" />
#### Twitter

```php
seo()->twitter('card', 'summary');
```

```php
use romanzipp\Seo\Structs\Meta\Twitter;

seo()->add(Twitter::make()->name('card')->content('summary'));
```

... both compile to ...

```html
<meta name="twitter:card" content="summary" />
```

#### Open Graph

```php
// <meta property="og:site_name" content="romanzipp" />
seo()->twitter('site_name', 'romanzipp');
```

seo()->add(OpenGraph::make()->property('site_name')->content('romanzipp'));
```php
use romanzipp\Seo\Structs\Meta\OpenGraph;

seo()->og('site_name', 'romanzipp');
seo()->add(OpenGraph::make()->name('site_name')->content('romanzipp'));
```

... both compile to ...

```html
<meta name="og:site_name" content="romanzipp" />
```

For more information see the [Structs Documentation](https://github.com/romanzipp/Laravel-SEO/blob/master/docs/STRUCTS.md).

### Render

```php
seo()->render();
```blade
{{ seo()->render() }}
```

## Cheat Sheet

| Code | Rendered HTML |
|--|--|
| `seo()->title('romanzipp')` | `<title>romanzipp</title>` |
| `seo()->meta('author', 'romanzipp')` | `<meta name="author" content="romanzipp" />` |
| `seo()->twitter('card', 'summary')` | `<meta name="twitter:card" content="summary" />` |
| `seo()->og('site_name', 'romanzipp')` | `<meta name="og:site_name" content="romanzipp" />` |
| `seo()->add(Charset::make()->charset('utf-8'))` | `<meta charset="utf-8" />` |

## Documentation

[Documentation](https://github.com/romanzipp/Laravel-SEO/blob/master/docs/INDEX.md)
Expand Down

0 comments on commit 3608cc0

Please sign in to comment.