Skip to content

Commit 5c1e9b0

Browse files
authored
README Tweaks
2 parents cf0e43f + 3052c87 commit 5c1e9b0

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.rst renamed to README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ You can also set the API key via the CLEARBIT_KEY environment variable.
2626
Then you can lookup people by email address. If the email's domain is corporate we'll also return a company response.
2727

2828
```python
29-
response = clearbit.Enrichment.find(email='alex@clearbit.com',stream=True)
29+
response = clearbit.Enrichment.find(email='alex@clearbit.com', stream=True)
3030
```
3131

3232
See the [documentation](https://clearbit.com/docs#person-api) for more information.
@@ -43,6 +43,16 @@ If the company can't be found, then `None` will be returned.
4343

4444
See the [documentation](https://clearbit.com/docs#company-api) for more information.
4545

46+
## Name to Domain
47+
48+
You can search for companies using name as a keyword:
49+
50+
```python
51+
response = clearbit.NameToDomain.find(name='Clearbit')
52+
```
53+
54+
See the [documentation](https://clearbit.com/docs#name-to-domain-api) for more information.
55+
4656
## Proxy Usage
4757

4858
Passing a proxies dictionary allows you to specify proxy servers to pass the requests through given various protocols.
@@ -54,7 +64,7 @@ proxies = {
5464
'https': 'https://user:password@proxyserver.tld:8080',
5565
}
5666

57-
response = clearbit.Enrichment.find(email='alex@clearbit.com',proxies=proxies)
67+
response = clearbit.Enrichment.find(email='alex@clearbit.com', proxies=proxies)
5868
```
5969

6070
## Testing

0 commit comments

Comments
 (0)