From 119ee97c7644d20a43245d161a2d52f7d94c9ce2 Mon Sep 17 00:00:00 2001 From: Thiago Santos Date: Mon, 17 Apr 2017 20:04:44 -0300 Subject: [PATCH 1/5] add message for twitter --- bin/seotopper.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/bin/seotopper.js b/bin/seotopper.js index 13ca945..0cdc208 100644 --- a/bin/seotopper.js +++ b/bin/seotopper.js @@ -176,7 +176,7 @@ const questions = [ { type: 'list', name: 'twitterCard', - message: 'Which twitter do you want', + message: 'Which twitter card do you want', choices: [ 'Summary', 'Product', From b316408ca4829878acb2a0434102b9b1963463ee Mon Sep 17 00:00:00 2001 From: Thiago Santos Date: Mon, 17 Apr 2017 21:39:57 -0300 Subject: [PATCH 2/5] Start documentation --- README.md | 204 +++++++++++++++++++++++++++++++-------------------- README.pt.md | 160 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 286 insertions(+), 78 deletions(-) create mode 100644 README.pt.md diff --git a/README.md b/README.md index d7f6400..0cd7c7d 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,104 @@ # Seotopper -Gerador de SEO mais TOP do momento, com meta tags do facebook, twitter, google+ entre outras. [Confira](http://quinalha.me/seotopper/) -# Novidade -JSON-LD - structured data markup Google Search +[![Travis](https://img.shields.io/travis/thiamsantos/seotopper.svg)](https://travis-ci.org/thiamsantos/seotopper) +[![npm (scoped)](https://img.shields.io/npm/v/seotopper.svg)](https://www.npmjs.com/package/seotopper) +[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo) + +> Short description. + +Long description. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam facilisis sem eros, vitae pellentesque sapien ultrices nec. Quisque accumsan nulla id mauris faucibus dictum. Curabitur eu ligula tellus. Phasellus volutpat ex augue. Pellentesque dictum auctor sem, ac semper diam fermentum et. + +*This README is also available in [Portuguese (Português)](README.pt.md).* + +## Table of Contents +- [Install](#install) +- [Usage](#usage) +- [Supported Tags](#supported-tags) +- [API](#api) +- [Contribute](#contribute) +- [License](#license) + +## Install + +This project uses [node](http://nodejs.org) and [npm](https://npmjs.com). Go check them out if you don't have them locally installed. + +```sh +$ npm install --save seotopper + +# To use the CLI is recommended to install it globally +$ npm install -g seotopper +``` + +## Usage + +```js +const seo = seotopper({ + title: 'Title of my page', + description: 'Description of my page', + author: 'Me', + base: 'https://your-url.com.br', + canonical: 'https://your-url.com.br', + sitemap: 'https://your-url.com.br/sitemap.xml', + robots: 'index, follow', + themeColor: '#f00', + image: 'https://your-url.com.br/images/intro.jpg', + facebook: true, + facebookType: 'website', + facebookSiteName: 'Example', + facebookLocale: 'en', + facebookId: '5349', + facebookAdmins: '123456789', + twitter: true, + twitterCard: 'summary' +}) +// Title of my page +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +``` + +### CLI +Interactive cli. + +## Supported Tags -# Meta-tags - title - description - author @@ -35,78 +129,32 @@ JSON-LD - structured data markup Google Search - twitter:image - application/ld+json -# v0.5 -```html -Título da minha página - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -``` +## API -# v0.1 -```html -Título da minha página - - - - - - - - - - - - - - - - - - - - - - - - - - -``` +## Contribute + +First off, thanks for taking the time to contribute! +Now, take a moment to be sure your contributions make sense to everyone else. + +### Reporting Issues + +Found a problem? Want a new feature? First of all see if your issue or idea has [already been reported](../../issues). +If don't, just open a [new clear and descriptive issue](../../issues/new). + +### Submitting pull requests + +Pull requests are the greatest contributions, so be sure they are focused in scope, and do avoid unrelated commits. + +- Fork it! +- Clone your fork: `git clone https://github.com//seotopper` +- Navigate to the newly cloned directory: `cd seotopper` +- Create a new branch for the new feature: `git checkout -b my-new-feature` +- Install the tools necessary for development: `npm install` +- Make your changes. +- Commit your changes: `git commit -am 'Add some feature'` +- Push to the branch: `git push origin my-new-feature` +- Submit a pull request with full remarks documenting your changes. + +## License + +[MIT license](LICENSE.md) © [Gustavo Quinalha](http://quinalha.me/) diff --git a/README.pt.md b/README.pt.md new file mode 100644 index 0000000..800ee9c --- /dev/null +++ b/README.pt.md @@ -0,0 +1,160 @@ +# Seotopper + +[![Travis](https://img.shields.io/travis/thiamsantos/seotopper.svg)](https://travis-ci.org/thiamsantos/seotopper) +[![npm (scoped)](https://img.shields.io/npm/v/seotopper.svg)](https://www.npmjs.com/package/seotopper) +[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo) + +> Short description. + +Long description. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam facilisis sem eros, vitae pellentesque sapien ultrices nec. Quisque accumsan nulla id mauris faucibus dictum. Curabitur eu ligula tellus. Phasellus volutpat ex augue. Pellentesque dictum auctor sem, ac semper diam fermentum et. + +*Este README também está disponpivel em [Inglês (English).](README.md)* + +## Índice +- [Instalação](#instalação) +- [Utilização](#utilização) +- [Tags Suportadas](#tags-suportadas) +- [API](#api) +- [Contribuir](#contribuir) +- [Licença](#licença) + +## Instalação + +Este projeto usa [node](http://nodejs.org) e [npm](https://npmjs.com). Veja se você não tem eles instalados localmente. + +```sh +$ npm install --save seotopper + +# Para usar a CLI é recomendado instalar globalmente +$ npm install -g seotopper +``` + +## Utilização + +```js +const seo = seotopper({ + title: 'Título da minha página', + description: 'Descrição da minha página', + author: 'Eu', + base: 'https://sua-url.com.br', + canonical: 'https://sua-url.com.br', + sitemap: 'https://sua-url.com.br/sitemap.xml', + robots: 'index, follow', + themeColor: '#f00', + image: 'https://sua-url.com.br/images/intro.jpg', + facebook: true, + facebookType: 'website', + facebookSiteName: 'Exemplo', + facebookLocale: 'en', + facebookId: '5349', + facebookAdmins: '123456789', + twitter: true, + twitterCard: 'summary' +}) +// Título da minha página +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +``` + +### CLI +Interactive cli. + +## Tags Suportadas + +- title +- description +- author +- base +- canonical +- sitemap +- robots +- googlebot +- theme-color +- msapplication-navbutton-color +- apple-mobile-web-app-status-bar-style +- name +- description +- image +- og:type +- og:title +- og:url +- og:site_name +- og:image +- og:description +- og:locale +- fb:app_id +- fb:admins +- twitter:card +- twitter:title +- twitter:description +- twitter:creator +- twitter:image +- application/ld+json + +## API + +## Contribuir + +Primeiramente, muito obrigado por tirar tempo para contribuir! +Agora, espere um momento para ter certeza de que suas contribuições fazem sentido para todos. + +### Reportando Issues + +Encontrou um problema? Quer uma nova funcionalidade? Antes de tudo veja se a sua issue ou idéia [já foi reportada](../../issues). +Se não, abra uma [nova issue](../../issues/new) de maneira clara e descritiva. + +### Submetendo pull requests + +Pull requests são as maiores contribuições, então tenha certeza que estão dentro do escopo, e evite commits não relacionados. + +- Faça um fork do projeto! +- Clone o seu fork: `git clone https://github.com//seotopper` +- Navegue até o diretório que acabou de ser clonado: `cd seotopper` +- Crie um novo branch para a nova funcionalidade: `git checkout -b my-new-feature` +- Instale as ferramentas necessárias para o desenvolvimento: `npm install` +- Faça as suas alterações. +- Faça o commit de suas alterações: `git commit -am 'Add some feature'` +- Faça um push do branch: `git push origin my-new-feature` +- Submeta um pull request documentando as suas alterações. + +## Licença + +[MIT license](LICENSE.md) © [Gustavo Quinalha](http://quinalha.me/) From 04dcd1cdaeae29323fc85a368bc64c4559bb2cd6 Mon Sep 17 00:00:00 2001 From: Thiago Santos Date: Tue, 25 Apr 2017 20:21:04 -0300 Subject: [PATCH 3/5] add description --- README.md | 4 ++-- README.pt.md | 4 +++- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0cd7c7d..603fc0e 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ [![npm (scoped)](https://img.shields.io/npm/v/seotopper.svg)](https://www.npmjs.com/package/seotopper) [![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo) -> Short description. +> Build the SEO of your site in seconds. -Long description. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam facilisis sem eros, vitae pellentesque sapien ultrices nec. Quisque accumsan nulla id mauris faucibus dictum. Curabitur eu ligula tellus. Phasellus volutpat ex augue. Pellentesque dictum auctor sem, ac semper diam fermentum et. +Get visible on the internet in seconds and share your pages in a more beautiful way with complete a SEO generator, it supports all meta-tags and [JSON-LD](http://json-ld.org/). *This README is also available in [Portuguese (Português)](README.pt.md).* diff --git a/README.pt.md b/README.pt.md index 800ee9c..69413b7 100644 --- a/README.pt.md +++ b/README.pt.md @@ -4,7 +4,9 @@ [![npm (scoped)](https://img.shields.io/npm/v/seotopper.svg)](https://www.npmjs.com/package/seotopper) [![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo) -> Short description. +> Construa o SEO de seu site em segundos. + +Fique visível na internet em segundos e compartilhe as suas páginas de uma maneira mais fácil com um gerador de SEO completo, ele tem suporte a todas as meta-tags e ao [JSON-LD](http://json-ld.org/). Long description. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam facilisis sem eros, vitae pellentesque sapien ultrices nec. Quisque accumsan nulla id mauris faucibus dictum. Curabitur eu ligula tellus. Phasellus volutpat ex augue. Pellentesque dictum auctor sem, ac semper diam fermentum et. From 060a799989039eed7ed81bbda6b098c6409e380f Mon Sep 17 00:00:00 2001 From: Thiago Santos Date: Tue, 25 Apr 2017 20:27:06 -0300 Subject: [PATCH 4/5] change badge --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 603fc0e..d996fbd 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Seotopper -[![Travis](https://img.shields.io/travis/thiamsantos/seotopper.svg)](https://travis-ci.org/thiamsantos/seotopper) +[![Travis](https://img.shields.io/travis/gustavoquinalha/seotopper.svg)](https://travis-ci.org/gustavoquinalha/seotopper) [![npm (scoped)](https://img.shields.io/npm/v/seotopper.svg)](https://www.npmjs.com/package/seotopper) [![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo) From 86ff2186a1408a50f60a564b0de1948fb1c79b11 Mon Sep 17 00:00:00 2001 From: Thiago Santos Date: Tue, 25 Apr 2017 20:30:34 -0300 Subject: [PATCH 5/5] remove lorem ipsum description --- README.pt.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.pt.md b/README.pt.md index 69413b7..841cf12 100644 --- a/README.pt.md +++ b/README.pt.md @@ -8,8 +8,6 @@ Fique visível na internet em segundos e compartilhe as suas páginas de uma maneira mais fácil com um gerador de SEO completo, ele tem suporte a todas as meta-tags e ao [JSON-LD](http://json-ld.org/). -Long description. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam facilisis sem eros, vitae pellentesque sapien ultrices nec. Quisque accumsan nulla id mauris faucibus dictum. Curabitur eu ligula tellus. Phasellus volutpat ex augue. Pellentesque dictum auctor sem, ac semper diam fermentum et. - *Este README também está disponpivel em [Inglês (English).](README.md)* ## Índice