Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dariusk/twoheadlines

@twoheadlines
https://github.com/dariusk/twoheadlines

Last synced: 23 days ago
JSON representation

@twoheadlines

Host: GitHub
URL: https://github.com/dariusk/twoheadlines
Owner: dariusk
Created: 2013-09-27T18:46:48.000Z (about 11 years ago)
Default Branch: public
Last Pushed: 2013-09-27T18:55:39.000Z (about 11 years ago)
Last Synced: 2024-10-13T21:35:08.349Z (about 1 month ago)
Language: CSS
Size: 328 KB
Stars: 38
Watchers: 5
Forks: 11
Open Issues: 0
Metadata Files:
- Readme: readme.md

Awesome Lists containing this project

README

# @TwoHeadlines (twoheadlines)

A Twitter bot that looks at news headlines and confuses them.

## Documentation
See [the nice-looking explanation of index.js](http://tinysubversions.com/twoheadlines/docs/) in order to understand how the bot works.

##Instructions

Requires [node](http://nodejs.org/) and [npm](http://npmjs.org/) (installing node installs npm too). You also need a Twitter App access token, consumer key, and associated secrets. [You can get those here](https://dev.twitter.com/apps/new). You'll probably also want a fresh twitter account for your bot, though you could have it post to one you already own, too!

Clone the repo, then in your project directory, install the dependencies:

`$ npm install`

Next, edit `config.js` to include your Twitter App access token, consumer key, and associated secrets. This is important! Without this you'll be unable to tweet.

Install/run `grunt` to lint your code and run `docco` to regenerate the documentation.

`$ npm install -g grunt-cli`
`$ grunt`

You can also run a watch in the background:

`$ grunt watch`

To actually run the bot, do:

`$ node index.js`

This will give you some output, including, after a bit, a bunch of text that is the tweet that's just been tweeted. You can check the twitter account to see if it's updated to verify that it actually works.

## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).