rherbrich / ocamltter

ocamltter is a Twitter client in OCaml. This client run on the OCaml toplevel interpreter. Then each operation on the client is just a OCaml function and you can develop a twitter program interactively.

              THE OCAMLTTER TWITTER CLIENT
              ============================

REQUIREMENT
===========
	
	You need:

           - Objective Caml 3.10, 3.11 or 3.12.0
             (available at http://caml.inria.fr/)

           - Cryptokit 1.3 or 1.4
             (available at http://pauillac.inria.fr/~xleroy/software.html)


INSTALLATION
============

        Nothing to do.


HOW TO USE
==========

        1. Run

           $ ./ocamltter

        2. You can use following commands:

           - l();;                 list timeline
           - lc COUNT;;            list timeline (COUNT lines)
           - lu "NAME";;           list NAME's timeline
           - m();;                 list mentions (tweet containing @YOU)
           - u "TEXT";;            post a new message
           - re ID "TEXT";;        reply to ID
           - del ID;;              delete tweet of ID
           - rt ID;;               retweet ID
           - qt ID "TEXT";;        qt ID
           - follow "NAME";;       follow NAME
           - unfollow "NAME";;     unfollow NAME
           - fav ID;;              mark ID as favorites
           - report_spam "NAME"    report NAME as a spam user
           - s "WORD";;            search tweets by a WORD
           - setup ();;            (re)authorize ocamltter
           - let CMD = ...;;       define a your own command CMD
           - help;;                print the help
	   
        3. You may modify the config.ml
           - You can set your twitter id
	   - You can set your interesting keywords
	   - You can set ignored users

        4. Quit

            #quit;;  or  ^D


BUGS REPORT
===========

        Send your bug reports at

          y.imai at ocaml.jp