Permalink
Browse files

update readme

  • Loading branch information...
1 parent b3d0569 commit b1d73d25cec2933cc39e6cea1c35397b178dd031 @lavelle committed Feb 9, 2013
Showing with 22 additions and 7 deletions.
  1. +1 −0 clipcloud.py
  2. +21 −7 readme.md
View
@@ -96,5 +96,6 @@ def main():
# Otherwise just call it
# else:
clipcloud()
+
if __name__ == '__main__':
main()
View
@@ -2,22 +2,36 @@
ClipCloud is a program for quickly sharing files. Currently it consists of a command line program written in Python that can upload files to Dropbox.
-A GUI is planned, as well as the ability to upload elsewhere, such as a personal server via SSH.
+## How do I get it?
+`[sudo] pip install clipcloud`
-It has only been primarily tested on Windows but most functionality also works on OS X and Linux. The Dropbox API is bundled with it, but you'll need to install its dependencies, `OAuth` `simplejson` separately and also `wxPython` if you want to take screenshots.
+or
-## Arguments:
+```
+git clone git://github.com/lavelle/ClipCloud.git
+cd ClipCloud
+[sudo] python setup.py install
+```
+
+## How do I use it?
+
+### Arguments:
- `up </path/to/file/or/folder> [second file, third file...]`: Upload the specified files and folders.
- `snap [-m mode]`: Take a screenshot and upload it. Mode can be `draw` or `screen`. Defaults to `screen`.
- `history [-l number_of_records] [-t sort_by] [-b start] [-d direction]`: Show a history of the files you've uploaded previously. Defaults to the last 10 records.
- `revisit <operation> <id>`: Do something with a previously uploaded file. `id` specifies which file to upload. `operation` can be either `upload`, `remote` or `local`.
- `text [-e extension]`: Share the contents of your clipboard. Currently uploads to Dropbox, support for Github Gists planned. Extenstion defaults to `txt`.
-## Options:
+### Options:
- `-s` `--share`: Specify what to do with the link to the uploaded file. Current options are sharing to Facebook, Twitter, Email, setting the clipboard or writing to stdout so you can pipe the url to other programs. Defaults to `clipboard`.
- `-h` `--help`: Display the help message
+## What does it need?
+- Python 2.6
+- Argparse if using Python version < 2.7
+- The Python Dropbox API and all its dependencies
+
+## Changelog
-## Todo:
-- Package as a .exe for distribution to users without Python
-- Add text snippet sharing to Github Gists?
+### 0.1
+- Inital release

0 comments on commit b1d73d2

Please sign in to comment.