Added search usage

shichao-an · Apr 12, 2015 · 0564b4c · 0564b4c
1 parent 4eb28db
commit 0564b4c
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/docs/source/cli.rst b/docs/source/cli.rst
@@ -12,7 +12,7 @@ There are two commands ``115down`` and ``115up`` that come with this package.
 Print help
 ~~~~~~~~~~
 
-You can a comprehensive help message using the ``-h`` option:
+You can print a comprehensive help message using the ``-h`` option:
 
 ::
 

diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst
@@ -256,6 +256,23 @@ Delete the file or directory:
     True
 
 
+Search directories and files
+----------------------------
+
+You can search directories and files by passing the ``keyword`` to :meth:`u115.API.search`:
+
+.. code-block:: python
+
+    >>> api.search('manga')
+    [<Directory: [WOLF][Mangaka-san][01-12+OVA01-06][GB][720P][END]>, <File: [WOLF][Mangaka-san][01][GB][720P].mp4>, ...]
+
+By default, the search result limits to 30 items. To get more result, pass ``count`` to the methods:
+
+.. code-block:: python
+    
+    >>> api.search('.mp4', count=100)
+
+
 Download files
 --------------