view release on metacpan or  search on metacpan

README.pod  view on Meta::CPAN

=pod

=for HTML <a href="https://travis-ci.org/mdom/txtnix"><img src="https://travis-ci.org/mdom/txtnix.svg?branch=master"></a>

=for HTML <a href='https://coveralls.io/r/mdom/txtnix?branch=master'><img src='https://coveralls.io/repos/mdom/txtnix/badge.png?branch=master' alt='Coverage Status' /></a>

=head1 NAME

txtnix - Client for twtxt, the minimalist microblogging service for hackers

=head1 SYNOPSIS

  $ txtnix --help

    Command:
    tweet       Append a new tweet to your twtxt file.
    timeline    Retrieve your personal timeline.
    view        Show feed of given source.
    follow      Add a new source to your followings.
    unfollow    Remove an existing source from your followings.
    following   Return the list of sources you're following.
    config      Get or set config item.
    query       Query your registry.
    register    Register at your registry.


    Options:
      --help      Print a help message and exit.
      --config    Specify a custom config file location.

   $ txtnix follow bob http://example.com/twtxt.txt
   $ txtnix tweet 'Hello twtxt world'
   $ txtnix timeline

=head1 DESCRIPTION

I<txtnix> is a client for the decentralised, minimalist microblogging service
for hackers L<https://github.com/buckket/twtxt>.

Instead of signing up at a closed and/or regulated microblogging platform,
getting your status updates out with twtxt is as easy as putting them in a
publicly accessible text file. The URL pointing to this file is your identity,
your account. twtxt then tracks these text files, like a feedreader, and builds
your unique timeline out of them, depending on which files you track. The
format is simple, human readable, and integrates well with UNIX command line
utilities.

All subcommand of I<txtnix> provides extensive help, so don't hesitate
to call them with the I<--help> option.

=head1 INSTALLATION

You can check L<INSTALL|https://github.com/mdom/txtnix/blob/master/INSTALL.pod>
to see all different ways to install txtnix but if want to use the fast and
easy way, the following commands will install txtnix and all dependencies to
~/perl5 and add lines to your bashrc to adjust some environment variables.

  $ curl -L http://cpanmin.us | perl - -l ~/perl5 App::cpanminus local::lib
  $ eval $(perl -I ~/perl5/lib/perl5 -Mlocal::lib=~/perl5)
  $ echo 'eval $(perl -I$HOME/perl5/lib/perl5 -Mlocal::lib)' >> ~/.bashrc
  $ cpanm https://github.com/mdom/txtnix.git

=head1 CONFIGURATION FILE

twtxt uses a simple INI-like configuration file. It checks