Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: update the file to show title plus syntax highlights #1

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

README: update the file to show title plus syntax highlights #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,20 @@ $ npm install --save shoebill-js
```


##Usage
## Usage

###JavaScript
```
###J avaScript
```js
/* Require and initialise the module*/
var ShoebillJS = require('shoebill-js');
var ShoebillJS = require('shoebill-js');
var sbjs = new ShoebillJS();

/* Generate your Metas */
sbjs.ogtitle('MyTitle');
sbjs.ogtype('website');
sbjs.ogsitename('My Website');
sbjs.ogdescription('Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec a diam lectus. Sed sit amet ipsum mauris. Maecenas congue ligula ac quam viverra nec consectetur ante hendrerit.');
sbjs.ogurl('http://www.myurl.com');
sbjs.ogurl('http://www.myurl.com');
sbjs.ogimage({
url: 'http://myurl.com/img/mylogo.png',
width: 300,
Expand All @@ -36,8 +36,8 @@ var metaTags = sbjs.toHTML();
/* Use metaTags variable and send your meta to your template ! */
```

###HTML Render
```
### HTML Render
```html
<head>
<meta property="og:title" content="MyTitle">
<meta property="og:type" content="website">
Expand All @@ -53,7 +53,7 @@ var metaTags = sbjs.toHTML();
</head>
```

The available meta are the following :
The available meta are the following :

- og:title
- og:type
Expand All @@ -65,17 +65,17 @@ The available meta are the following :
- og:locale:alternate
- og:image
- og:image:url
- og:image:secure_url
- og:image:secure_url
- og:image:type
- og:image:width
- og:image:height
- og:video
- og:video:secure_url
- og:video:secure_url
- og:video:type
- og:video:width
- og:video:height
- og:audio
- og:audio:secure_url
- og:audio:secure_url
- og:audio:type

- twitter:card
Expand Down