README

# HelloTxt Ruby Client/Library

== Authors

* Kevin Williams (<https://kevwil.github.io/>)

== CODE:

<https://github.com/kevwil/hellotxt/>

== DESCRIPTION:

HelloTxt (<http://hellotxt.com>) is a simple service that makes updating your social networks a snap, and this is it's Ruby library.

== FEATURES/PROBLEMS:

* Installing the gem creates a 'hellotxt' shell script to post from the shell.
* Keys are stored in a YAML file in your home directory (%USERPROFILE% in Windows).

== SYNOPSIS:

Shell usage:

  $ hellotxt "This message will post to my default services."

Everything after the 'hellotxt' command is what will be posted to the service. You could do the same thing without the quotes, and it would still work:

  $ hellotxt updating from the command line is very handy for developers.

If your keys have not been stored, it will ask for them.  These keys will be saved
in a YAML file in your home directory and you won't be asked for them again.

You can obtain your API key and user key here: <http://hellotxt.com/developers/applications>

Library usage:

## Require the library and initialize it

  require 'hellotxt'
  hellotxt = ::HelloTxt::Client.new('api_key', 'user_key')

## Ensure proper API and USER keys

  hellotxt.validate['status']

## => 'OK' if success, otherwise 'FAIL'

## Posting to all services

  hellotxt.post('The Dark Knight was amazing.')

## => {'status' => 'OK'} if success, otherwise 'FAIL'

Check the source comments for more details.

== REQUIREMENTS:

Ruby!

== INSTALL:

  $ (sudo) gem install hellotxt

  (you really should try RVM if you still need sudo to manage your gems. <https://rvm.io/>)

== RUN TESTS:

  $ (sudo) gem install bones-extras
  $ rake

  (you really should try RVM if you still need sudo to manage your gems. <https://rvm.io/>)