README.md in saber-1.1.0 vs README.md in saber-1.1.1
- old
+ new
@@ -1,81 +1,38 @@
-Saber, a complete solution for PT users. [![Build Status](https://secure.travis-ci.org/GutenYe/saber.png)](http://travis-ci.org/GutenYe/saber)
+Saber, a complete solution for PT users. [![Build Status](https://secure.travis-ci.org/SaberSalv/saber.png)](http://travis-ci.org/SaberSalv/saber)
==========================================
| | |
|----------------|-----------------------------------------|
-| Homepage: | https://github.com/GutenYe/saber |
-| Author: | Guten |
+| Homepage: | https://github.com/SaberSalv/saber |
+| Author: | Saber |
| License: | MIT-LICENSE |
-| Documentation: | https://github.com/GutenYe/saber/wiki |
-| Issue Tracker: | https://github.com/GutenYe/saber/issues |
+| Documentation: | https://github.com/SaberSalv/saber/wiki |
+| Issue Tracker: | https://github.com/SaberSalv/saber/issues |
**Features:**
* Add Torrent: send a torrent file from website to rutorrent.
-* Upload: upload a torrent file from command line to the site.
* Fetch: automatically/manually fetch files from seedbox to home-laptop.
+* Upload: upload a torrent file from command line to the site.
* Other Tasks:
- Make: make a torrent file and copy it to local and remote watch directory.
- Send: send files from home-laptop to seedbox.
- Clean: remove files which are not seeded in rtorrent.
-you can find more tools at [here](https://github.com/GutenYe/saber/wiki/Tools).
+you can find more tools at [here](https://github.com/SaberSalv/saber/wiki/Tools).
Getting Started
----------------
-Create ~/.saberrc configuration file from [template](https://github.com/GutenYe/saber/blob/master/templates/_saberrc). More detail will be explained below.
+Create ~/.saberrc configuration file from [template](https://github.com/SaberSalv/saber/blob/master/templates/_saberrc). More detail will be explained below.
### Add Torrent
-See [saber-addtorrent](https://github.com/GutenYe/saber-addtorrent) project.
+See [saber-addtorrent](https://github.com/SaberSalv/saber-addtorrent) project.
-### Upload
-Because of lacking APIs in major PT sites, so I write this small script to help uploading a torrent from cmdline. Good news is BTN v2.0 will include API. And BTN already has an official autobot which grabs scene releases. :)
-
-> Support sites: BIB
-
-Configure ~/.saberrc
-
- p:
- watch = Pa("~/bt/watch")
- remote_watch = Pa("bt/watch")
-
- username = "foo"
- bib:
- username = "bar"
- announce_url = "x"
-
- server:
- user = "x"
- host = "y"
-
-Fill \<info-data>.yml file and upload it.
-
- $ saber.bib g magazine hello.pdf
- > create hello.pdf.yml
- $ vim hello.pdf.yml
-
- type: magazines
- Title: Hello
- Description: Hello World
- ...
-
- $ saber.bib upload hello.pdf.torrent
- > Upload Complete
-
- $ saber.bib upload hello.pdf # short cut
- > make hello.pdf.torrent
- > Upload Complete
-
-Auto fill \<info-data>.yml file from isbn.
-
- $ saber.bib g ebook hello.epub 1781100055
- > create hello.epub.yml
-
### Fetch
#### AutoFetch
Configure ~/.saberrc
@@ -113,11 +70,11 @@
$ saber client -V
Test if it works
- (server) $ saber drb_add <rtorrent_file_hash_id> saber
+ (server) $ saber drb_add <rtorrent_file_hash_id> saber -V
(client) > aria2 should begin download file from ftp://seedbox/bt/<file>
Automatically fetch: when a file is finished download in rutorrent with label 'saber', then it'll add to aria2.
Manually fetch: right click 'Saber Fetch' in rutorrent web ui, then it'll add to aria2.
@@ -140,13 +97,57 @@
ftp = "ftp://seedbox/bt"
Begin fetch a file from seedbox
$ saber fetch foo
- > download ftp://seedbox/bt/foo/a.epub
- > download ftp://seedbox/bt/foo/b.epub
+ > begin to download ftp://seedbox/bt/foo/a.epub via aria2
+ > begin to download ftp://seedbox/bt/foo/b.epub via aria2
+### Upload
+
+Because of lacking APIs in major PT sites, so I write this small script to help uploading a torrent from cmdline. Good news is BTN v2.0 will include API. And BTN already has an official autobot which grabs scene releases. :)
+
+> Support sites: BIB
+
+Configure ~/.saberrc
+
+ p:
+ watch = Pa("~/bt/watch")
+ remote_watch = Pa("bt/watch")
+
+ username = "foo"
+ bib:
+ username = "bar"
+ announce_url = "x"
+
+ server:
+ user = "x"
+ host = "y"
+
+Fill \<info-data>.yml file and upload it.
+
+ $ saber.bib g magazine hello.pdf
+ > create hello.pdf.yml
+ $ vim hello.pdf.yml
+
+ type: magazines
+ Title: Hello
+ Description: Hello World
+ ...
+
+ $ saber.bib upload hello.pdf.torrent
+ > Upload Complete
+
+ $ saber.bib upload hello.pdf # short cut
+ > make hello.pdf.torrent
+ > Upload Complete
+
+Auto fill \<info-data>.yml file from isbn.
+
+ $ saber.bib g ebook hello.epub 1781100055
+ > create hello.epub.yml
+
### Tasks
#### Make
Configure ~/.saberrc
@@ -196,48 +197,39 @@
use `saber help` to list all tasks.
Install
-------
-_Main article_: [Install Saber](https://github.com/GutenYe/saber/wiki/Install)
+_Main article_: [Install Saber](https://github.com/SaberSalv/saber/wiki/Install)
$ gem install saber
$ install it's dependencies
- Archlinux: pacaur -S saber
-
-Resources
----------
-
-* [Archlinux](http://www.archlinux.org): A simple, lightweight linux distribution.
-* [pacaur](https://github.com/Spyhawk/pacaur): An AUR helper for ArchLinux.
-* [YAAW](https://github.com/binux/yaaw): Yet Another Aria2 Web Frontend in pure HTML/CSS/Javascirpt.
-
-Development [![Dependency Status](https://gemnasium.com/GutenYe/saber.png?branch=master)](https://gemnasium.com/GutenYe/saber) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/GutenYe/saber)
+Development [![Dependency Status](https://gemnasium.com/SaberSalv/saber.png?branch=master)](https://gemnasium.com/SaberSalv/saber) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/SaberSalv/saber)
===========
Contributing
--------------
+------------
* Submit any bugs/features/ideas to github issue tracker.
-Pull requests are very welcome! Please try to follow these simple rules if applicable:
+Please see [Contibution Documentation](https://github.com/SaberSalv/saber/blob/master/CONTRIBUTING.md).
-* Please create a topic branch for every separate change you make.
-* Make sure your patches are well tested.
-* Coding Style Guide: https://gist.github.com/1105334
+A list of [Contributors](https://github.com/SaberSalv/saber/contributors).
-Contributors
-------------
+Resources
+---------
-[https://github.com/GutenYe/saber/contributors](https://github.com/GutenYe/saber/contributors)
+* [Archlinux](http://www.archlinux.org): A simple, lightweight linux distribution.
+* [pacaur](https://github.com/Spyhawk/pacaur): An AUR helper for ArchLinux.
+* [YAAW](https://github.com/binux/yaaw): Yet Another Aria2 Web Frontend in pure HTML/CSS/Javascirpt.
Copyright
---------
(the MIT License)
-Copyright (c) 2011-2012 Guten
+Copyright (c) 2011-2012 Saber
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.