Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
add use video
  • Loading branch information
piyook committed Feb 23, 2024
1 parent 5526548 commit e71ff8a
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ Results can be copied to local clipboard as JSON data and pasted into a code edi

### NOTE: This is a demo project only. Never put Open AI API keys inside a production frontend client application. Instead create a backend API to contact Open AI and relay the response back to the client app using any required authorisation method

![intro view](images/intro.png) ![loading view](images/loading.png)
![response view1](images/response.png) ![response view1](images/response2.png)
![intro view](images/intro.png)

## Set-up

Expand All @@ -31,6 +30,12 @@ This will start up up the VITE dev server and serve the app from localhost:5173

## Using



https://github.com/piyook/ai-colour-picker/assets/51154763/c15d8b56-628c-4ccd-82c2-f4805a48b118



Enter a word or phrase to send to OpenAI to generate the desired number of colours. Press 'enter' or click the submit button to send a request.

The OpenAI API response is streamed and the colours updated as they are received by the app in real time. This method was chosen over waiting for a full response to complete before dispaying the colours produced. This was due to the length of the response times - especially for a larger number of colours, and the lack of feedback to a user.
Expand Down

0 comments on commit e71ff8a

Please sign in to comment.