Update README.md

README.md

@@ -13,8 +13,7 @@
 
 POST `/api/v1/jobs/`
 ### Request Schema
-
+```plaintext
-```plaintex
 Required
 ├── site_type (List[enum]): linkedin, zip_recruiter, indeed
 └── search_term (str)
@@ -27,7 +26,6 @@ Optional
 ├── easy_apply (bool): only for linkedin
 └── output_format (enum): json, csv, gsheet
 ```
-
 ### Request Example
 ```json
 "site_type": ["indeed", "linkedin"],
@@ -38,7 +36,6 @@ Optional
 "results_wanted": 15
 "output_format": "gsheet"
 ```
-
 ### Response Schema
 ```plaintext
 site_type (enum): 
@@ -138,13 +135,10 @@ linkedin, Software Engineer 1, Public Partnerships | PPL, https://www.linkedin.c
 ```
 
 ## Installation
-
+### Docker Setup
-## Docker Image (simple)
 _Requires [Docker Desktop](https://www.docker.com/products/docker-desktop/)_
 
-[JobSpy API Image](https://ghcr.io/cullenwatson/jobspy:latest) is continuously updated and available on GitHub Container Registry. You can pull and use the image with:
+[JobSpy API Image](https://ghcr.io/cullenwatson/jobspy:latest) is continuously updated and available on GitHub Container Registry.
-
-## Usage Docker
   
 To pull the Docker image:
 
@@ -152,12 +146,12 @@ To pull the Docker image:
 docker pull ghcr.io/cullenwatson/jobspy:latest
 ```
   
-### Params
+#### Params
   
-By default, 
+By default:
-* `client_secret.json` in current directory  (if using Google Sheets, see below to obtain)
+* Port: `8000`
-* Listens on port `8000`
+* Google sheet name: `JobSpy`
-* Places the jobs into a sheet that is named JobSpy
+* Relative path of `client_secret.json` (for Google Sheets, see below to obtain)
   
  To run the image with these default settings, use:
   
@@ -171,18 +165,24 @@ Example (Unix):
 docker run -v $(pwd)/client_secret.json:/app/client_secret.json -p 8000:8000 ghcr.io/cullenwatson/jobspy
 ```
   
-### Using custom params
+#### Using custom params
 
-  For example, 
+  Example: 
-   * port `8030`,
+   * Port `8030`
-   * path `C:\config\client_secret.json`
+   * Google sheet named `CustomName`
-   * Google sheet name `JobSheet`
+   * Absolute path of `client_secret.json`: `C:\config\client_secret.json`
   
 ```bash
-docker run -v C:\config\client_secret.json:/app/client_secret.json -e GSHEET_NAME=JobSheet -e PORT=8030 -p 8030:8030 ghcr.io/cullenwatson/jobspy
+docker run -v C:\config\client_secret.json:/app/client_secret.json -e GSHEET_NAME=CustomName -e PORT=8030 -p 8030:8030 ghcr.io/cullenwatson/jobspy
 ```
   
-### Google Sheets Integration
+### Python installation (alternative to Docker)
+_Python version >= [3.10](https://www.python.org/downloads/release/python-3100/) required_  
+1. Clone this repository `git clone https://github.com/cullenwatson/jobspy`
+2. Install the dependencies with `pip install -r requirements.txt`
+4. Run the server with `uvicorn main:app --reload`
+  
+### Google Sheets Setup
   
 #### Obtaining an Access Key: [Video Guide](https://youtu.be/w533wJuilao?si=5u3m50pRtdhqkg9Z&t=43)
   * Enable the [Google Sheets & Google Drive API](https://console.cloud.google.com/)
@@ -192,10 +192,12 @@ docker run -v C:\config\client_secret.json:/app/client_secret.json -e GSHEET_NAM
   * Go to the Keys tab -> add key -> create new key -> JSON -> Create
   
 #### Using the key in the repo
-  * Copy the key file into the JobSpy repo as `/client_secret.json`
+  * Copy the key file into the JobSpy repo as `client_secret.json`
-  * Go to [my template sheet](https://docs.google.com/spreadsheets/d/1mOgb-ZGZy_YIhnW9OCqIVvkFwiKFvhMBjNcbakW7BLo/edit?usp=sharing) & save as a copy into your account
+  * Go to [my template sheet](https://docs.google.com/spreadsheets/d/1mOgb-ZGZy_YIhnW9OCqIVvkFwiKFvhMBjNcbakW7BLo/edit?usp=sharing): File -> Make a Copy -> Rename to JobSpy
-  * Share the Google sheet with the email in `client_email` in the `client_secret.json`  above with editor rights
+  * Share the Google sheet with the email located in the field `client_email` in the `client_secret.json` above with editor rights
-  * If you changed the name of the sheet, put the name in `GSHEET_NAME` in `/settings.py`
+  * If you changed the name of the sheet:
+    - Python install: add `.env` in the repo and add `GSHEET_NAME` param with the sheet name as the value, e.g. `GSHEET_NAME=CustomName`
+    - Docker install: use custom param `-e GSHEET_NAME=CustomName` in `docker run` (see above)
   
 ### How to call the API
   
@@ -207,12 +209,6 @@ To use Postman:
 #### Swagger UI:
 Or you can call the API with the interactive documentation at [localhost:8000/docs](http://localhost:8000/docs).
   
-
-## Python installtion (alternative to Docker)
-_Python version >= [3.10](https://www.python.org/downloads/release/python-3100/) required_  
-1. Clone this repository `git clone https://github.com/cullenwatson/jobspy`
-2. Install the dependencies with `pip install -r requirements.txt`
-4. Run the server with `uvicorn main:app --reload`
 ## FAQ
   
 ### I'm having issues with my queries. What should I do?
@@ -230,7 +226,6 @@ The auth uses [supabase](https://supabase.com). Create a project with a `users`
   
 <img src="https://github.com/cullenwatson/jobspy/assets/78247585/03af18e1-5386-49ad-a2cf-d34232d9d747" width="500">
   
-
 Add these three environment variables:
   
 - `SUPABASE_URL`: go to project settings -> API -> Project URL