Skip to content

Commit e7ea529

Browse files
committed
updated readme to include pip installation instructions'
1 parent c0fcc8d commit e7ea529

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.MD

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,12 @@ This is a simple Python Wrapper for the UCSF [Industry Documents Library](https:
44

55
It offers basic functionality to perform queries on the API to retrieve metadata of the documents in the library.
66

7-
The two main methods are:
7+
You will want to install the package using `pip`:
8+
9+
`pip install industryDocumentsWrapper`
10+
11+
12+
The the package has one class `IndustryDocsSearch` with two main methods of are:
813
* `IndustryDocsSearch.query()`: performs the query on the API
914
* `IndustryDocsSearch.save()`: saves query results as a JSON or Parquet file.
1015

0 commit comments

Comments
 (0)