README.rdoc

Path: README.rdoc
Last Update: Wed Jun 01 23:33:08 +0200 2011

RuGPost

*RuGPost* (Ruby, Gmail and Posterous) is a command line facility which allows you to create posts on your own [posterous](posterous.com) sites using your GMail account.

You simply start creating your site local repo where adding your drafts. Drafts are written using *textile* lightweight markup.

When a draft is ready for publishng, you just need to publish it. *RuGPost* will convert the draft to *html* and will create a post on the related site for you, using your GMail account.

Installation

    gem install RuGPost

Usage

Create and initialize a RuGPost project:

    mkdir MyProject
    cd MyProject
    rugpost init
                rugpost config --gmail=gmailusername

Add a repository (must have same name of the posterous site):

    rugpost repo RuGPost

Create your first draft in the just created site repo:

    rugpost draft helloworld

Publish your draft:

    rugpost publish helloworld gmailpassword

That‘s all. Note that if you follow the above steps as is, you should be able to post in a minute a nice ‘helloworld’ on rugpost.posterous.com. You are invited to do so.

Help

For help about the available commands use:

    rugpost --help

For help about a specific command use:

    rugpost --help <command>

Contributing to RuGPost

  • Check out the latest master to make sure the feature hasn‘t been implemented or the bug hasn‘t been fixed yet
  • Check out the issue tracker to make sure someone already hasn‘t requested it and/or contributed it
  • Fork the project
  • Start a feature/bugfix branch
  • Commit and push until you are happy with your contribution
  • Make sure to add tests for it. This is important so I don‘t break it in a future version unintentionally.
  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright

Copyright (c) 2011 empo. See LICENSE.txt for further details.

[Validate]