Skip to content

Commit

Permalink
Hotfix: add the documentation to the project. close #5
Browse files Browse the repository at this point in the history
- README.md: set up the correct highlight.
- setup.py: add the long_description programmatically from the
README.md.
  • Loading branch information
Rubén Héctor García committed Sep 15, 2019
1 parent 03d697f commit a97893f
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 4 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@ with a JSON content in the following format:
### The log


The output should look something close to:
```bash
The output should look like this:
```log
INFO:tropescraper.tvtropes_scraper:Process started
* Remember that you can stop and restart at any time.
** Please, remove manually the cache folder when you are done
Expand Down Expand Up @@ -90,7 +90,9 @@ anything goes bad :-) and it can be ignored.
If you are a contributor and you want to work and improve the code
you only need clone the project and install all the dependencies with:

```
```bash
git clone https://github.com/raiben/tropescraper.git
cd tropescraper
pip install -r requirements.txt
```

Expand Down
10 changes: 9 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,16 @@
from os import path

from setuptools import setup

this_directory = path.abspath(path.dirname(__file__))
with open(path.join(this_directory, 'README.md'), encoding='utf-8') as readme_file:
long_description = readme_file.read()

setup(name='tropescraper',
version='1.0.1',
version='1.0.2',
description='A TvTropes scrapper',
long_description=long_description,
long_description_content_type='text/markdown',
url='https://github.com/raiben/tropescraper',
author='Rubén H. García',
author_email='raiben@gmail.com',
Expand Down

0 comments on commit a97893f

Please sign in to comment.