docs: update docs

.pre-commit-config.yaml

@@ -1,3 +1,4 @@
+default_stages: [push]
 repos:
 -   repo: /~https://github.com/pre-commit/pre-commit-hooks
     rev: v3.2.0
@@ -24,6 +25,7 @@ repos:
     rev: v2.28.0
     hooks:
     -   id: commitizen
+        stages: [commit-msg]
 -   repo: /~https://github.com/PyCQA/isort
     rev: 5.10.1
     hooks:

CHANGELOG.md

@@ -4,10 +4,10 @@
 
 ### Features
 
-* Initial commit (83277e0)[/~https://github.com/pruizlezcano/comicgeeks/commit/83277e07bd17b4bd68684302cf6908759300f142]
-* First release (4ef2898)[/~https://github.com/pruizlezcano/comicgeeks/commit/4ef28988ec751ad58187174eeb948539c3bfc6f6]
+* Initial commit ([83277e0](/~https://github.com/pruizlezcano/comicgeeks/commit/83277e07bd17b4bd68684302cf6908759300f142))
+* First release ([4ef2898](/~https://github.com/pruizlezcano/comicgeeks/commit/4ef28988ec751ad58187174eeb948539c3bfc6f6))
 
 ### Fixes
-* **docs** Error building docs (eb03282)[/~https://github.com/pruizlezcano/comicgeeks/commit/eb03282f15c5684720fed27626cbff23f818455c]
-* **docs** More build errors (fe3f7b1)[/~https://github.com/pruizlezcano/comicgeeks/commit/fe3f7b146c8ba5d098a8ed583511e6c833d55a01]
-* * **docs** More build errors -_- (e227707)[/~https://github.com/pruizlezcano/comicgeeks/commit/e2277079e7e0d56ef4963788dc42d0f176a85671]
+* **docs** Error building docs ([eb03282](/~https://github.com/pruizlezcano/comicgeeks/commit/eb03282f15c5684720fed27626cbff23f818455c))
+* **docs** More build errors ([fe3f7b1](/~https://github.com/pruizlezcano/comicgeeks/commit/fe3f7b146c8ba5d098a8ed583511e6c833d55a01))
+* **docs** More build errors -_- ([e227707](/~https://github.com/pruizlezcano/comicgeeks/commit/e2277079e7e0d56ef4963788dc42d0f176a85671))

CONTRIBUTING.md

@@ -150,11 +150,26 @@ conda activate comicgeeks
    This should automatically use [flake8]/[black] to check/fix the code style in a way that is compatible with the project.
 
 
-   > Don't forget to add documentation in case your
-   contribution adds an additional feature and is not just a bugfix.
+   > Don't forget to add unit tests and documentation in case your contribution adds an additional feature and is not just a bugfix.
 
    To commit your changes, please use the [conventional commits] specification.
 
+4. Please check that your changes don't break any unit tests with:
+
+   ```
+   tox
+   ```
+
+   (after having installed [tox] with `pip install tox` or `pipx`).
+
+   To run all the tests, create a file in the root directory of the project with the name `.devdata.env` and add your [leagueofcomicgeeks.com] ci_session to it:
+   ```
+   CI_SESSION="mycisession"
+   ```
+
+   You can also use [tox] to run several other pre-configured tasks in the
+   repository. Try `tox -av` to see a list of the available checks.
+
 ### Submit your contribution
 
 1. If everything works fine, push your local branch to the remote server with:

README.md

@@ -25,19 +25,19 @@ pip install comicgeeks
 ```python
 from comicgeeks import Comic_Geeks
 
-scraper = Comic_Geeks("my_ci_session")
+client = Comic_Geeks("my_ci_session")
 
 # search series
-scraper.search_series("daredevil")
+client.search_series("daredevil")
 
 # get new releases
-scraper.new_releases()
+client.new_releases()
 
 # get info about an issue
-scraper.issue_info(3616996)
+client.issue_info(3616996)
 ```
 
-For more info check the documentation in [http...](http...)
+For more info check the documentation in [https://comicgeeks.readthedocs.io](https://comicgeeks.readthedocs.io)
 
 ## Contributing
 Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.