Chore: small update to the README file (#43)

* chore: small update to the docs * chore: new screenshot for the docs * chore: improve readme file info
thisdot · Dec 1, 2023 · aecd0ae · aecd0ae
1 parent b9a1352
commit aecd0ae
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -12,18 +12,22 @@ Welcome to the `movies-api` repository! This open-source project provides a comp
 
 ## Getting Started
 
+### Base URL
+
+The base URL for our API is `https://0kadddxyh3.execute-api.us-east-1.amazonaws.com`. All endpoints are prefixed with this base URL.
+
 ### Obtaining an Access Token
 
 To use our API, first, obtain a bearer token:
 
-1. Send a `GET` request to `<final URL here>/auth/token`.
+1. Send a `GET` request to `/auth/token`.
 2. Use this token in the Authorization header of your subsequent API calls.
 
 ### Setting Up the GraphQL Sandbox
 
 1. Open the GraphQL sandbox endpoint and click on the connection settings
 
-   [ add image here ]
+![connection settings](./screenshots/GraphQL_sandbox_connection_settings_1.png)
 
 2. Update the headers by adding the `Authorization` bearer token
 
@@ -56,7 +60,7 @@ Here's a list of our available API endpoints:
 
 ### GraphQL Queries
 
-GraphQL queries can be accessed using the endpoint `/graphql`. Open the sandbox at `<add final URL here>` and take a look at the query schema documentation.
+GraphQL queries can be accessed using the endpoint `/graphql`. Open the sandbox at `/graphql` and take a look at the query schema documentation.
 
 ![graphql query schema documentation](./screenshots/GraphQL_schema_query_doc.png)
 

diff --git a/screenshots/GraphQL_sandbox_connection_settings_1.png b/screenshots/GraphQL_sandbox_connection_settings_1.png