the-crawler-twitter
==========

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/the-labo/the-crawler-twitter
[bd_travis_url]: http://travis-ci.org/the-labo/the-crawler-twitter
[bd_travis_shield_url]: http://img.shields.io/travis/the-labo/the-crawler-twitter.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/the-labo/the-crawler-twitter
[bd_travis_com_shield_url]: https://api.travis-ci.com/the-labo/the-crawler-twitter.svg?token=
[bd_license_url]: https://github.com/the-labo/the-crawler-twitter/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/the-labo/the-crawler-twitter
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/the-labo/the-crawler-twitter.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/the-labo/the-crawler-twitter.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/the-labo/the-crawler-twitter
[bd_gemnasium_shield_url]: https://gemnasium.com/the-labo/the-crawler-twitter.svg
[bd_npm_url]: http://www.npmjs.org/package/the-crawler-twitter
[bd_npm_shield_url]: http://img.shields.io/npm/v/the-crawler-twitter.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Crawler for twitter

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>



<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>

Installation
-----

```bash
$ npm install the-crawler-twitter --save
```


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>

Usage
---------

```javascript
'use strict'

const theDB = require('the-db')
const { TheTwitterCrwl } = require('the-crawler-twitter')

async function tryExample () {
  const db = theDB({ /* ... */ })

  {
    class TweetResource extends theDB.Resource { /* ... */ }
    class TweetHtml extends theDB.Resource { /* ... */ }
    db.load(TweetResource, 'Tweet')
    db.load(TweetHtml, 'TweetHtml')
  }
  {
    let crwl = new TheTwitterCrwl({
      resources: {
        consumerKey: 'xxxxxxxxxxxxxxxxxxx',
        consumerSecret: 'xxxxxxxxxxxxxxxxxxx',
        accessTokenKey: 'xxxxxxxxxxxxxxxxxxx',
        accessTokenSecret: 'xxxxxxxxxxxxxxxxxxx',
        Resource: db.resources.Tweet,
        HtmlResource: db.resources.TweetHtml
      }
    })
    await crwl.run({})
  }
}

tryExample().catch((err) => console.error(err))

```


<!-- Section from "doc/guides/02.Usage.md.hbs" End -->

<!-- Section from "doc/guides/10.API Guide.md.hbs" Start -->

<a name="section-doc-guides-10-a-p-i-guide-md"></a>

API Guide
-----

+ [the-crawler-twitter@1.0.3](./doc/api/api.md)
  + [create(args)](./doc/api/api.md#the-crawler-twitter-function-create)


<!-- Section from "doc/guides/10.API Guide.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/the-labo/the-crawler-twitter/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------

+ [THE Labo][t_h_e_labo_url]

[t_h_e_labo_url]: https://github.com/the-labo

<!-- Links End -->