fry-send_tweet.rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ff77de5abd98525df5babd93cfb108c6e1fd60612ed29d2f508a213eeb46d527
+  data.tar.gz: cb1b6beafceec98a3622f5650d403a09006fa4dbf80092c5b3cc86c9a2cdab88
+SHA512:
+  metadata.gz: fc75531a52115c92e6e171edebc4eafeb87f844ca0860f2e8a28d08f7e043c551095a72e80afa712fec2e3eacd8af1d1b2e6e9f95a9edbc9c7a01c48ced16412
+  data.tar.gz: 81684f84db430dc7cf1acf044e2991a02359fde085a2ff570cb838698872715669fce7072acaec2e430d91dc42b379b28776c2f0e1550db8c04015f7d28c144c

data/CHANGELOG.md

@@ -0,0 +1,282 @@
+# CHANGELOG
+
+## master
+
+* Read media contents into memory immediately to avoid the potential for
+  tampering between the time tweet is scheduled and its actual creation.
+
+* Update `README.md` documentation to include `on-twitter --set-profile-location`.
+
+* Include the time of the last and next refresh cycle when rendering
+  tweets that are automatically refreshed every `X` seconds.
+
+* `TimeAgoInWords` represents a past tense Time object as
+  `<number> <unit> before <time>`.
+
+* A single instance of `Twitter::REST::Client` shared across potentially
+  multiple threads is not going to work, re-create `Twitter::REST::Client`
+  instance before each eval, that is local to its Pry instance.
+
+* Switch to `Pry#add_sticky_local` for inserting the special local variable,
+ `_twitter_`.
+
+* Add `config.twitter.default_read_size`, for setting the default number of
+  tweets to request from Twitter when reading tweets via its API.
+
+## v0.13.1
+
+* Load `$HOME/.pry-send_tweet.yml` using `YAML.safe_load()`.
+
+* Add `time-ago-in-words` README and gemspec to Rubygem package.
+
+## v0.13.0
+
+* Remove `Gemfile`, and the Bundler dependency.
+
+* On the FreeBSD VM, runtime dependencies are installed as FreeBSD packages.
+
+* Rethink fork + wait logic in `read-tweets`.
+
+* Configure the default timezone on the FreeBSD VM to be CET (Central European Time).
+  This can be changed by `$VMTZ`. Please see the README for an example.
+
+* `on-twitter --show-following` and `on-twitter --show-followers` accept an
+  optional regular expression that can filter through the result set.
+
+* Implement `ruby vms/freebsd.rb --fresh`, for destroying an old VM and
+  spinning up a new one.
+
+* Implement `time-ago-in-words` without patching the Time class.
+
+* Remove `spec/`.
+
+* Timestamps in the future or present are represented as '0 seconds' ago
+  in `lib/time-ago-in-words`.
+
+* Replace 'time-lord' with 'time-ago-in-words'
+
+* Print an error when unknown switches are passed to command
+
+* Switch default editor to 'ee' on FreeBSD VM
+
+* Add mitigation for RCE bug in apt-get to Dockerfile.
+
+* `--delay`, and `--self-destruct` assume that a time such as 07:00, which  
+  has past on the current day, was meant to mean 07:00, tomorrow.
+
+* Install FreeBSD-12 with Vagrant due to unresolvable issues with the
+  HardenedBSD vagrant box.  
+
+* Replace `t.co` links with the expanded URL `t.co` redirects to.  
+
+* Collect status of system pager after sending `SIGKILL`.
+
+* When translating text or a tweet, show the source and destination language.  
+
+* Add `read-tweets -sl=`, `read-tweets --source-lang=` for setting the source    
+  language of the text or tweet being translated.
+
+* Add `read-tweets -tx`, for translating a piece of text using the Yandex  
+  translation API.
+
+* Set CET (Central European Time) as the default timezone for the HardenedBSD VM.
+
+* Implement a minimum box height of 8, but scale to a larger number if a tweet  
+  or user bio is written using a lot of newlines.
+
+* Remove the `config.box_height` option.
+
+* Typo fix: rescue `Twitter::Error`, not `Timeout::Error`, when liking a tweet.
+
+## v0.12.1
+
+* Correct multiple grammar errors found in the help output of all commands.
+
+## v0.12.0
+
+* Add `Vagrantfile` & related files to spawn a VirtualBox VM running  
+  [HardenedBSD](https://hardenedbsd.org).
+
+* Distribute `samples/*` as part of the Rubygem package.  
+
+## v0.11.0
+
+* Apply a fix to tty-box for the `on-twitter --show-followers`, and  
+  `on-twitter --show-following` commands.
+
+* Add unicode support by applying a fix - as a monkey patch - to the `tty-box`  
+  gem.
+
+* Add `unicode-display_width`, and `unicode-emoji` as runtime dependencies.  
+
+* Add `read-tweets -x`, `read-tweets --translate` -  for translating tweets,  
+  using the Yandex translation API.
+
+* `on-twitter --follow` & `on-twitter --unfollow` understand a string such as  
+  `https://twitter.com/StephenKing/media` to mean `@StephenKing`.
+
+* Include a URL to a users profile when following or unfollowing them.
+
+* Remove duplicate username when replying to a tweet. This could happen when the  
+  tweet author and the person replying to the tweet are the same.  
+
+* Update `Pry::SendTweet::UserRenderer` to use `config.box_width`, and  
+  `config.box_height`.
+
+* Use `page_ok()` from `send-tweet` command.  
+
+## v0.10.1
+
+* Improve forking implementation in `Pry::SendTweet::TweetRenderer`.
+
+* Improve the workaround for weak unicode support in tty-box.
+
+* Add `Pry.config.twitter.box_height` - for defining the height of the box that  
+  contains a tweet or user.
+
+* Add `Pry.config.twitter.box_width`, formerly `Pry.config.twitter.line_width`.
+
+## v0.10.0
+
+* Avoid a negative argument error when following / unfollowing other user(s) by  
+  bypassing tty-box for those operations.
+
+* Improve the title that appears above tweets when using the `read-tweets`  
+  command.  
+
+* Add support for `read-tweets -t https://twitter.com/username`.
+
+* Add `--set-profile-location`, and `--set-profile-link-color=` to the  
+ `on-twitter` command.  
+
+## v0.9.0
+
+* Render `Twitter::Tweet` and `Twitter::User` objects using `TTY::Box` - with the  
+  knowledge that it has bugs and limitations that will need to be fixed in the   
+  future.  
+
+* Improve `send-tweet --reply-to` by writing the tweet owners screen name   
+  and all other user mentions in their tweet to the temp file created    
+  to compose a reply.  
+
+* Add `on-twitter --show-following` to show the newest tweeters you have started  d
+  to follow.
+
+* Add `on-twitter --show-followers` to show the newest tweeters to have followed   
+  you.
+
+* Add the option to configure pry-send_tweet through a YAML file.  
+
+* Add `dockerize.sh` to gem package.  
+
+* Add README documentation for following related actions.
+
+* Add README documentation for all `on-twitter` actions related to a users  
+  profile.
+
+## v0.8.0ddd
+
+* Add sticky local variable `_twitter_` to the active Binding.
+
+## v0.7.0
+
+* Add `send-tweet -n`, `send-tweet --no-newline`, for removing newlines from a   
+  tweet before sending it.
+
+* Add `twitter-action --mute-user=`
+
+* Add `twitter-action --suggested-users=`, `twitter-action --suggested-topics`  
+  and `twitter-action --suggested-lang`.
+
+* Add configuration option, `Pry.config.twitter.line_width`, for choosing the  
+  a lines width before word wrapping occurs. Default line width is 200.
+
+* Add pre-post tweet validation that catches empty tweets, and tweets who use  
+  too many characters.
+
+* Add `send-tweet --delay=xx` for delaying the creation of a tweet by a number  
+  of seconds.
+
+* Add `send-tweet --self-destruct=xx` for automatically deleting a tweet after  
+  a number of seconds.
+
+* Add `twitter-search`.
+
+* Add `read-tweets --tweeter=`, a longer version of `read-tweets -t`.  
+
+* Add `read-tweets --replies <user>`.
+
+* Add short hand variants for all `read-tweets` options.
+
+* Combine the `read-tweets` options `--my-likes` and `--liked-by` into  
+  one option, `--likes`.
+
+* Rename `read-tweets --that-mention-me` to `read-tweets --mentions`.
+
+* Don't hit the Twitter API if a composed tweet is entirely whitespace.
+
+* `send-tweet --file` accepts a comma separated list for attaching multiple  
+   images to a tweet.
+
+* Like, unlike, and delete actions accept a comma separated list for performing  
+  an action on multiple tweets.
+
+## v0.6.0
+
+* Fix a bug where the auto refresh feature could not be disabled.   
+ `Pry.config.twitter.refresh_interval` should be set to `false` instead of  
+ `nil` to disable this feature.  
+
+* Modify `render_tweets()` to accept the optional keyword argument, 'timeout'.
+
+* Render liked, unliked, and deleted (re)tweets via `render_tweets()`.
+
+* Change default User-Agent sent with requests to the Twitter API to `pry-send_tweet vX.Y.Z`
+
+* Add the option to configure the `User-Agent` sent with requests to the Twitter API,  
+  via `Pry.config.twitter.user_agent`.
+
+* Add `Pry::SendTweet::VERSION`.
+
+## v0.5.3
+
+* Fix another NoMethodError
+
+## v0.5.2
+
+* Fix a NoMethodError when following a user.
+
+* Update gemspec to include all files checked into git.
+
+## v0.5.1
+
+* Update an outdated description for the `read-tweets` command.
+
+* Group the `send-tweet` command under the `Twitter` group, it was previously  
+  grouped as '(other)'.
+
+## v0.5.0
+
+* Automatically refresh the tweets on display every 4 minutes.
+
+* `Pry.config.twitter.refresh_interval` can be used for setting a custom refresh  
+   interval. The default is 240 seconds, or 4 minutes.
+
+* Add the command `read-tweets`.
+
+* Add the command `twitter-action`, aliased as `on-twitter`.
+
+## v0.4.0
+
+* Add support for attaching an image to a tweet with
+  the optional `-f` / `--file` switch:
+
+  `send-tweet --file /path/to/image.jpg`
+
+## v0.3.0
+
+* Compose a tweet using `pry.editor`
+
+## v0.2.1
+
+* Don't escape tweet content using 'Shellwords'.

data/LICENSE.txt

@@ -0,0 +1,24 @@
+Copyright (c) 2018, Robert Gleeson
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the Fry organization nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/PRY_LICENSE.txt

@@ -0,0 +1,25 @@
+License
+-------
+
+(The MIT License)
+
+Copyright (c) 2011-2019 The Pry Team
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,456 @@
+# fry-send_tweet.rb
+
+* [Introduction](#introduction)
+* [API Access](#api-access)
+* [Configuration - required](#configuration)
+* [Usage](#usage)
+  * [Sending Tweets](#sending-tweets)
+  * [Reading Tweets](#reading-tweets)
+  * [Deleting Tweets](#deleting-tweets)
+  * [Liking Tweets](#liking-tweets)
+  * [Following / unfollowing](#following-unfollowing)
+  * [Searching Twitter](#searching-twitter)
+  * [Retweets](#retweets)
+  * [Profile Actions](#profile-actions)
+  * [Twitter Suggestions](#twitter-suggestions)
+  * [Muting other users](#muting-other-users)
+  * [Sticky local variable: `_twitter_` ](#special-variable-_twitter_)
+  * [Tip: Command Aliases](#tip)
+* [Multi-tasking: tmux / screen](#multi-tasking)
+* [Install](#install)
+  * [Rubygem](#install-rubygem)
+  * [Virtual Machines](#vms)
+    * [FreeBSD](#vms-freebsd)
+* [Screenshots](#screenshots)
+* [License](#license)
+
+## <a id='Introduction'>Introduction</a>
+
+An extensible Twitter client that lives inside the Pry and Fry REPLs.
+
+## <a id='api-access'>API Access</a>
+
+Using the Twitter API requires a developer account.
+Follow the instructions at [https://developer.twitter.com](https://developer.twitter.com)
+if you haven't already setup access to the Twitter API.
+
+## <a id='configuration'>Configuration (required)</a>
+
+The placeholder keys and tokens in the below example can be replaced
+by those from your developer account. pry-send_tweet.rb can be configured from
+a `.pryrc` file using Ruby, or through a YAML file located at
+`$HOME/.pry-send_tweet.yml`
+
+__1. Ruby__
+
+```ruby
+# .pryrc
+Pry.configure do |config|
+  config.twitter = Pry::Config.from_hash({
+    # Required
+    consumer_key: '<consumer key>',
+    consumer_secret: '<consumer secret>',
+    access_token: '<access token>',
+    access_token_secret: '<access token secret>',
+    # Optional
+    # The number of tweets to request from Twitter when reading tweets via
+    # its API. The default is 200, a lower number could speed up requests if
+    # you find them to be slow.
+    default_read_size: 100,
+    # Optional
+    # The User-Agent to use when making requests to the Twitter API.
+    # Default is: 'pry-send_tweet.rb vX.Y.Z'.
+    user_agent: 'Custom User-Agent',
+    # Optional
+    # The width of a box that contains a tweet or user. The default width is 100.
+    box_width: 120,
+    # Optional
+    # A Yandex API key for translating tweets when using `read-tweets -x`.
+    yandex_key: 'xxx',
+    # Optional
+    # The language tweets should be translated to, the default is 'en' (English).
+    yandex_lang: 'ru'
+  })
+end
+```
+
+__2. YAML__
+
+`$HOME/.pry-send_tweet.yml`:
+
+```yaml
+---
+# Required
+consumer_key: '<consumer key>'
+consumer_secret: '<consumer secret>'
+access_token: '<access token>'
+access_token_secret: '<access token secret>'
+# Optional
+default_read_size: 100
+# Optional
+user_agent: 'Your User-Agent string'
+# Optional
+box_width: 120
+# Optional
+yandex_key: xxx
+yandex_lang: xx
+```
+
+## <a id='usage'>Usage</a>
+
+There are four commands added to Pry by this plugin, those commands are:
+
+  * `send-tweet`
+    For sending tweets.
+
+  * `read-tweets`
+    For reading tweets.
+
+  * `twitter-action` (aliased as: `on-twitter`)
+    For performing misc actions on Twitter, such as following, unfollowing, etc.
+
+  * `twitter-search`
+    For searching Twitter.
+
+Each command provides help, that can be shown by appending `--help` to the
+command. Example:
+
+    [1] pry(main)> send-tweet --help
+
+### <a id='sending-tweets'>Sending tweets</a>
+
+
+* Send a tweet:
+
+      # Your editor opens (`_pry_.editor`), compose a tweet then hit save & close.
+      # You'll then get the url for your tweet:
+      [1] pry(main)> send-tweet
+      https://twitter.com/xxx/status/xxx
+
+
+* Send a tweet with an image attached:
+
+      [1] pry(main)> send-tweet --file #{File.join ENV['HOME'], 'photos', 'image.jpg'}
+
+
+* Send a tweet with multiple images attached:
+
+      [1] pry(main)> send-tweet --file #{%w[1.jpg 2.jpg 3.jpg].join(',')}
+
+* Reply to a tweet:
+
+      [1] pry(main)> send-tweet --reply-to https://twitter.com/username/status/1
+
+* Send a tweet that will self-destruct after 70 seconds.
+It's worth adding that if the Pry process exits this operation will be cancelled:
+
+      [1] pry(main)> send-tweet --self-destruct=70
+
+* Send a tweet that will be published 70 seconds in the future.
+It's worth adding that if the Pry process exits, this operation will be cancelled:
+
+      [1] pry(main)> send-tweet --delay=70
+
+* Delay sending a tweet until 12AM, today. `--self-destruct` also supports this
+  syntax:
+
+      [1] pry(main)> send-tweet --delay=00:00
+
+### <a id='reading-tweets'>Reading tweets</a>
+
+By default the tweets displayed by the `read-tweets` command  are automatically
+refreshed every 5 minutes.
+
+That can be changed to a custom interval by setting `Pry.config.twitter.refresh_interval`
+to a number of seconds, or to `false` if you want to disable this feature.
+
+* Read recent tweets from your timeline:
+
+      [1] pry(main)> read-tweets
+
+* Read recent tweets from the timeline of another user:
+
+      [1] pry(main)> read-tweets -t rubygems
+
+* Read recent tweets that `@mention` you:
+
+      [1] pry(main)> read-tweets --mentions
+
+* Read recent tweets that you've liked:
+
+      [1] pry(main) read-tweets --likes
+
+* Read recent tweets liked by another user:
+
+      [1] pry(main)> read-tweets --likes ladygaga
+
+* Read recent tweets sent as replies by a given user, the example uses `@github`:
+
+      [1] pry(main)> read-tweets --replies github
+
+* Read a translated copy of a tweet, using the
+  [Yandex translation API](https://translate.yandex.com/developers).
+  The configuration instructions for Yandex are included in the [configuration section](#configuration).
+
+      [1] pry(main)> read-tweets -x https://twitter.com/user/status/1
+
+* Read a translated copy of a piece of text:
+
+      [1] pry(main)> read-tweets -tx='#{File.binread "persian.txt"}'
+      [2] pry(main)> read-tweets -tx='Guten Tag'
+      [3] pry(main)> read-tweets -tx='Hola'
+
+* Sometimes Yandex cannot detect the language of the text or tweet being
+  translated, or it will guess the source language incorrectly. In case
+  this happens, the source language can be set explicitly:
+
+      [1] pry(main)> read-tweets --source-lang=fa -x https://url/to/farsi/tweet
+      [1] pry(main)> read-tweets --source-lang=sw -tx='Habari yako'
+
+* Read 100 recent tweets instead of the default 200 recent tweets.
+  **Tip:** `--count` can be combined with all of the options described above.
+
+      [1] pry(main)> read-tweets --count 100
+
+* By default retweets are not displayed.
+  To display retweets, pass the `--with-retweets` option.
+
+      [1] pry(main)> read-tweets --with-retweets
+
+### <a id='deleting-tweets'>Deleting tweets</a>
+
+* Delete one or more tweets with a comma separated list:
+
+      [1] pry(main)> on-twitter --delete-tweet https://twitter.com/username/status/1,https://twitter.com/username/status/2
+
+* Delete one or more retweets with a comma separated list:
+
+      [1] pry(main)> on-twitter --delete-retweet https://twitter.com/username/status/1,https://twitter.com/username/status/2
+
+### <a id='liking-tweets'>Liking tweets</a>
+
+* Like one or more tweets with a comma separated list:
+
+      [1] pry(main)> on-twitter --like https://twitter.com/user/status/1,https://twitter.com/user/status/2
+
+* Unlike one or more tweets with a comma separated list:
+
+      [1] pry(main)> on-twitter --unlike https://twitter.com/user/status/1,https://twitter.com/user/status/2
+
+### <a id='following-unfollowing'> Following / unfollowing </a>
+
+* Follow one or more tweeters with a comma separated list:
+
+      [1] pry(main)> on-twitter --follow user1,user2,user3
+
+* Unfollow one or more tweeters with a comma separated list:
+
+      [1] pry(main)> on-twitter --unfollow user1,user2,user3,user4
+
+* Show the tweeters who are following you:
+
+      [1] pry(main)> on-twitter --show-followers
+
+* Show the tweeters who you follow:
+
+      [1] pry(main)> on-twitter --show-following
+
+* Both `--show-following` and `--show-followers` accept an optional argument
+  that can be used to filter the result set.
+
+      [1] pry(main)> on-twitter --show-following=[0-9]$
+
+### <a id='searching-twitter'>Searching Twitter</a>
+
+The `twitter-search` command can be used to search Twitter.
+
+* Search Twitter using a given hashtag:
+
+      [1] pry(main)> twitter-search #ruby
+
+### <a id='retweets'>Retweets</a>
+
+* Retweet one or more tweets with a comma separated list:
+
+      [1] pry(main)> on-twitter --retweet https://twitter.com/user/status/1,https://twitter.com/user/status/2
+
+### <a id='profile-actions'>Profile actions</a>
+
+* Set the name visible on your profile:
+
+      [1] pry(main)> on-twitter --set-profile-name=<name>
+
+* Set the profile bio / description visible on your profile:
+
+      # An editor opens (`_pry_.editor`), write your bio then hit save & close.
+      # Your profiles bio will be updated after closing the editor.
+      [1] pry(main)> on-twitter --set-profile-bio
+
+* Set the location visible on your profile:
+
+      # An editor opens (`_pry_.editor`), write a location then hit save & close.
+      # Your profiles location will be updated after closing the editor.
+      [1] pry(main)> on-twitter --set-profile-location
+
+* Set the color (as a hex value) of links that appear on your profiles timeline:
+
+      [1] pry(main)> on-twitter --set-profile-link-color=#CC0000
+
+* Set the URL visible on your profile:
+
+      [1] pry(main)> on-twitter --set-profile-url=https://github.com/you
+
+* Set profile image:
+
+      [1] pry(main)> on-twitter --set-profile-image /path/to/image.jpg
+
+* Set the banner image visible on your profile:
+
+      [1] pry(main)> on-twitter --set-profile-banner-image /path/to/image.jpg
+
+
+### <a id='twitter-suggestions'>Twitter Suggestions</a>
+
+* View a list of suggested topics, optionally restricted to Spanish:
+
+      [1] pry(main)> on-twitter --suggested-lang=es --suggested-topics
+
+* View a list of suggested users from a given topic, optionally restricted to
+  Spanish:
+
+      [1] pry(main)> on-twitter --suggested-lang=es --suggested-users=<topic>
+
+
+### <a id='muting-other-users'>Muting other users</a>
+
+* Mute one or more users with a comma separated list:
+
+      [1] pry(main)> on-twitter --mute-user=user1,user2,user3
+
+* Unmute one or more users with a comma separated list:
+
+      [1] pry(main)> on-twitter --unmute-user=user1,user2,user3,user4
+
+
+### <a id='special-variable-_twitter_'>Sticky local variable: `_twitter_`</a>
+
+The local variable `_twitter_` is inserted into the active Binding, providing
+a programmable API accessible to Ruby code as well as a lower level of access to
+the Twitter API. It is meant for exploration, development, and debugging.
+The local variable is considered reserved.
+
+The local variable returns an instance of `Twitter::REST::Client`:
+
+      [1] pry(main)> _twitter_
+      => #<Twitter::REST::Client:0x00007ff44cd6dce0
+          @access_token="xxx",
+          @access_token_secret="xxx",
+          @consumer_key="xxx",
+          @consumer_secret="xxx",
+          @user_agent="pry-send_tweet.rb v0.7.0">
+
+### <a id='tip'>Tip: Command Aliases</a>
+
+When there are Twitter accounts you read often, it can turn out to be faster
+to create command aliases for reading those accounts. An example follows, a
+hyphen is included in the aliased commands to avoid collisions with Ruby code.
+
+```ruby
+# .pryrc
+Pry.commands.alias_command "prez-trump", "read-tweets -t realdonaldtrump"
+Pry.commands.alias_command "prez-obama", "read-tweets -t barackobama"
+```
+
+## <a id='multi-tasking'>Multi-tasking: tmux / screen</a>
+
+To get the most out of `pry-send_tweet.rb` I use tmux to manage a pane for reading
+tweets and another for writing tweets. I've found this to be the best way since
+a single shell does not allow for multi tasking but tmux and screen do.
+
+I use [tmuxinator](https://github.com/tmuxinator/tmuxinator) to manage my tmux
+sessions. The tmuxinator configuration I use is checked into the repo in the
+hope that it might be useful to others.
+
+* [tmuxinator-vagrant.yml](./samples/tmuxinator-vagrant.yml)
+
+## <a id='vms'>Virtual Machines</a>
+
+Before getting started with a Virtual Machine, download and install the
+following tools if you didn't already, they're free:
+
+* VirtualBox
+* Vagrant
+
+Next, configure access to the Twitter API by adding `.pryrc` file to the root of
+the repository. That's covered in the [configuration](#configuration) section.
+
+### Shared space
+
+While exploring, developing or tweeting on one of the available VMs sometimes
+you want to bring files from the 'host' machine to the virtual machine, which
+is known as the guest machine.
+
+__Syncing files__
+
+`vagrant rsync-auto` can see edits made to the cloned repo on the host
+machine and sync those changes back to the guest machine. To set this up, from
+the root of the repo on the host machine run:
+
+    $ vagrant rsync-auto
+
+__Tweeting media__
+
+To tweet media such as an image or video from the VM, what I do is drop those
+files into `/app/shared-space` and then reference `/app/shared-space` when
+sharing them, eg `send-tweet -f /app/shared-space/photo.jpg`.
+
+### <a id='vms-freebsd'>FreeBSD</a>
+
+[FreeBSD 12](https://freebsd.org) Virtual Machine
+
+Vagrant will use Amazon to download the box image. Sometimes the download can be
+slow, sometimes the download can stall..
+
+Keep trying if this happens, a download should always resume from the point
+where it finished. FreeBSD is worth the perseverance. :)
+
+    $ git clone https://github.com/r-obert/pry-send_tweet.rb
+    $ cd pry-send_tweet.rb
+    $ ruby vms/freebsd.rb
+
+Screenshots __#1__, __#2__ in the [screenshots](#screenshots) section show the
+type of experience to expect when running `ruby vms/freebsd.rb`.
+
+A virtual machine can be destroyed and a new VM instance created by appending
+the `--fresh` option:
+
+    $ ruby vms/freebsd.rb --fresh
+
+The default time settings are set to CET (Central European Time). This can be
+changed with an environment variable.
+
+    $ VMTZ=Asia/Tehran ruby vms/freebsd.rb
+
+A complete list of time zones are available in the VM:
+
+    $ ls /usr/share/zoneinfo
+
+## <a id='install'>Install</a>
+
+### <a id='install-rubygem'>Rubygem</a>
+
+    $ gem install pry-send_tweet.rb
+
+## <a id='screenshots'>Screenshots</a>
+
+__#1__ Running FreeBSD 12 with Vagrant, Tmux
+
+![FreeBSD-1](/art/44-e44743a5bb.jpg)
+
+__#2__ Composing a tweet on FreeBSD 12 - with Vagrant, Tmux.
+
+![FreeBSD-2](/art/52-eec4df2edf.jpg)
+
+## <a id='license'>License</a>
+
+This project uses the MIT license, see [LICENSE.txt](./LICENSE.txt) for details.