README.md in saber-0.0.3 vs README.md in saber-0.0.4

- old
+ new

@@ -1,50 +1,77 @@ Saber, a complete solution for PT users. ======================================== | Homepage: | https://github.com/GutenYe/saber | |----------------|-----------------------------------------| -| Author: | Guten Ye | +| Author: | Guten | | License: | MIT-LICENSE | -| Documentation: | http://rubydoc.info/gems/saber/frames | | Issue Tracker: | https://github.com/GutenYe/saber/issues | -the saber. - ### Is It Good? Yes. ### Is It "Production Ready™"? No. +What saber can do for you? + +* addtorrent: send torrent file to rutorrent in a PT website directly. +* download: + 1. manually download a file to home laptop in rutorrent web ui. + 2. automatically downlad files to home laptop when files are completed in seedbox. +* task: + 1. cleanup files not in rtorrent. + Usage ----- -Task: manually download file from server. +### addtorrent - # start aria2 user daemon - $ ~/etc/rc.d/aria2 start - $ saber download "Prison Break" - # aria2 will begin download. +see https://github.com/Gutenye/saber-addtorrent -Task: clean up undownload files, all files remains in disk, but don't in rtorrent client. - $ saber clean +### download -Install --------- + # server side + # start rtorrent + $ /etc/rc.d/saber-server start # start saber server daemon. -server side + # client side + $ ~/etc/rc.d/aria2 start # start aria2 daemon. + $ ~/etc/rc.d/saber-client start # start saber client daemon. + + # manually download + right click 'Saber Download' in rutorrent web ui, then it adds to aria2. - begin ssh + # automatically download + when a file is finished download in rutorrent with label 'saber', then it adds to aria2. -client side + +### task - gem install saber +clean up undownload files, all files remains in disk, but don't in rtorrent client. + # server side + $ saber clean + +Install +-------- + + # server side + $ gem install saber + $ pacaur -S rutorrent-saber-git + $ pacaur -S saber-server-daemon-git + + # client side + $ gem install saber + $ pacaur -S user-aria2-daemon-git # an aria2 daemon + $ pacaur -S thebear-git # optional. a web front end to aria2. + $ pacaur -S user-saber-client-daemon-git + Contributing ------------- * Feel free to join the project and make contributions (by submitting a pull request) * Submit any bugs/features/ideas to issue tracker @@ -56,17 +83,18 @@ * [Contributors](https://github.com/GutenYe/saber/contributors) Resources --------- - some related resources to help each other. +* [pacaur](https://github.com/Spyhawk/pacaur): An AUR installer for ArchLinux. +* [TheBear](http://sourceforge.net/projects/thebear/): a web front end to aria2. Copyright --------- (the MIT License) -Copyright (c) 2011 Guten Ye +Copyright (c) 2011 Guten Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.