Moved tests to "test". Improved README.

publicos-pt · Apr 26, 2015 · d925b2e · d925b2e
1 parent aa68933
commit d925b2e
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@ of the Portuguese law.
 
 ## Author
 
-The authors of this package are Jorge C. Leitão and Helder Guerreiro.  
+The authors of this package are Jorge C. Leitão and Helder Guerreiro.
 
 ## The code
 
@@ -16,15 +16,15 @@ This package is written in Python 2+3, depends on beautifulSoup 4
 
 Run the tests with:
 
-    python -m unittest tests
+    python -m unittest test
 
 ## Usage
 
-The API consists of 4 functions that return meta-data an text of a given document
+The API consists of 4 functions that return meta-data and text of a given document
 or publication as a Python dictionary:
 
-* `get_publication(publication_id)`: returns the publication_id
-* `get_publications(document_id)`: returns the list of publications of a document_id.
-* `get_document(document_id)`: returns a single dictionary with a document_id;
+* `get_publication(publication_id)`: returns the publication `publication_id`
+* `get_publications(document_id)`: returns the list of publications of a `document_id`.
+* `get_document(document_id)`: returns a single dictionary with a `document_id`;
 * `get_documents(series, year)`: returns a list of dictionaries, each entry a 
-  document_id with respective publications.
+  `document_id` with respective publications.
diff --git a/tests/__init__.py → test/__init__.py b/tests/__init__.py → test/__init__.py