tweetcat

0.0.8 • Public • Published

tweetcat

WIP - This is highly experimental!

p2p pipe across the internet using Twitter as a transport stream.

Installation

npm install -g tweetcat

Setup

Before you can use tweetcat you need to create an app on Twitter. Follow the steps below to get started (you need to have a phone number associated with your Twitter account).

  1. Create a new app
  2. Choose a unique name, e.g. tweetcat-<github-username>
  3. Put in a dummy website, e.g. http://example.com
  4. Leave Callback URL blank
  5. When the application have been created you should be taken to the app page. From here, click 'Keys and Access Token' and note the 'Consumer Key' and the 'Consumer Secret'

When you've successfully created the Twitter app, continue with initialization:

tweetcat --init

Usage

tweetcat [username]

Where username is a Twitter user (without the @).

Todo's

  • Add tests
  • Allow transfer of binary data
  • Allow transfer of data larger than 140 chars
  • Find solution to distributing Twitter API consumer key/secret
  • Implement two-way handshake so that one side of the conversation doesn't start sending before the other is listening

License

MIT

Package Sidebar

Install

npm i tweetcat

Weekly Downloads

4

Version

0.0.8

License

MIT

Last publish

Collaborators

  • watson