Skip to content
This repository has been archived by the owner on Sep 5, 2024. It is now read-only.

Commit

Permalink
more readme adjustments
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelharms committed Jan 19, 2020
1 parent df9f6b7 commit 9e4a35a
Showing 1 changed file with 3 additions and 7 deletions.
10 changes: 3 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ pip install comcrawl

### Basic

The HTML for each page will be available as a string in the 'html' key in each results dictionary after calling the `download` method.

```python
from comcrawl import IndexClient

Expand All @@ -46,7 +48,7 @@ client = IndexClient()
client.search("reddit.com/r/MachineLearning/*")
client.download()

results = client.results
first_page_html = client.results[0]["html"]
```

### Multithreading
Expand All @@ -62,8 +64,6 @@ client = IndexClient()

client.search("reddit.com/r/MachineLearning/*", threads=4)
client.download(threads=4)

results = client.results
```

### Removing duplicats & Saving
Expand Down Expand Up @@ -99,8 +99,6 @@ from comcrawl import IndexClient
client = IndexClient(["2019-51", "2019-47"])
client.search("reddit.com/r/MachineLearning/*")
client.download()

results = client.results
```

### Logging HTTP requests
Expand All @@ -113,8 +111,6 @@ from comcrawl import IndexClient
client = IndexClient(verbose=True)
client.search("reddit.com/r/MachineLearning/*")
client.download()

results = client.results
```

## Code of Conduct
Expand Down

0 comments on commit 9e4a35a

Please sign in to comment.