Update README

Author: kaustubhkagrawal

README.md

@@ -1,27 +1,41 @@
-# Vapiai
+# Vapi Example for Express
 
 [![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/-BeLLh) [![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy) [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)
 
-✨ **This workspace has been generated by [Nx, Smart Monorepos · Fast CI.](https://nx.dev)** ✨
+Welcome to the Vapi Serverless Vercel sample project. This project demonstrates how you can extend the functionalities of Vapi, an abstraction layer for your personal assistant, to create a unique experience tailored for story writers. Using this project, writers can design characters for their stories through voice interactions with the assistant.
 
-## Start the app
+## Project Overview
 
-To start the development server run `nx serve vapiai`. Open your browser and navigate to http://localhost:4200/. Happy coding!
+The project showcases the following customizations:
 
-## Generate code
+- **Function Calling**: Writers can invoke custom functions to retrieve character inspirations and generate random names based on specific criteria. For more info [click here](api/custom-llm/README.md)
+- **Custom Large Language Model (LLM) Integration**: Enhance conversational capabilities by integrating custom LLMs with Vapi for nuanced and context-aware interactions. For more info [click here](api/functions/README.md)
+- **Server URL Events**: Handle various events during a call's lifecycle, such as function calls and assistant requests, to provide dynamic responses. For more info [click here](api/webhook/README.md)
 
-If you happen to use Nx plugins, you can leverage code generators that might come with it.
+## Features
 
-Run `nx list` to get a list of available plugins and whether they have generators. Then run `nx list <plugin-name>` to see what generators are available.
+- **Creative Prompts for Character Development**: Utilize the function that provides creative prompts for character development to get inspired based on a query provided by the author.
+- **Random Name Generation**: Use a public endpoint to generate random names, with options to specify gender and nationality based on user input.
+- **Advanced Conversational Interactions**: Leverage advanced LLMs to improve natural language understanding and generation for complex conversations.
 
-Learn more about [Nx generators on the docs](https://nx.dev/features/generate-code).
+## Getting Started
+
+To get started with this project:
+
+1. Clone the repository to your local machine.
+2. Install the dependencies by running `pnpm install`.
+3. Explore the `src/handlers` directory to understand how the function calling and custom LLM integrations and webhook event handling are set up.
+4. Review the types directory to see the data structures used for handling Vapi events and payloads.
+5. Check the data directory for sample data that the function for creative character prompts can use.
+6. Remove any unnecessary code and start adding your own logic.
+7. There is sample json in `./assistants` folder. You can use that to create Vapi assistant and then test it.
 
 ## Running tasks
 
 To execute tasks with Nx use the following syntax:
 
 ```
-nx <target> <project> <...options>
+nx <target> vapiai <...options>
 ```
 
 You can also run multiple targets:
@@ -38,31 +52,26 @@ nx run-many -t <target1> <target2> -p <proj1> <proj2>
 
 Targets can be defined in the `package.json` or `projects.json`. Learn more [in the docs](https://nx.dev/features/run-tasks).
 
-## Want better Editor Integration?
-
-Have a look at the [Nx Console extensions](https://nx.dev/nx-console). It provides autocomplete support, a UI for exploring and running tasks & generators, and more! Available for VSCode, IntelliJ and comes with a LSP for Vim users.
-
 ## Ready to deploy?
 
-Just run `nx build demoapp` to build the application. The build artifacts will be stored in the `dist/` directory, ready to be deployed.
+Just run `nx build demoapp` to build the application. The build artifacts will be stored in the `dist/vapiai` directory, ready to be deployed.
+
+## Assistant Setup.
 
-## Set up CI!
+- **Using Dashboard**: For you to create an assistant you can create a simple one by directly going to your dashboard and creating one from the UI.
+- **Using POST Endpoint**: You can also create your assistant using POST `https://api.vapi.ai/assistant` with your API Key (Dashboard > Accounts > Vapi Keys) as Bearer Token and choose any body from `./assistants` folder.
 
-Nx comes with local caching already built-in (check your `nx.json`). On CI you might want to go a step further.
+Once assistant is created You may setup your server Url (`http://<domain>/api/webhook`) in the Dashboard > Accounts > Settings > Server URL. This will set the server URL for all assistants. If you want to set the serverUrl per assistant by using `serverUrl` key in the assistant body while creating.
 
-- [Set up remote caching](https://nx.dev/features/share-your-cache)
-- [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution)
-- [Learn more how to setup CI](https://nx.dev/recipes/ci)
+## Examples
 
-## Explore the Project Graph
+Here are some examples of how the custom functionalities can be used:
 
-Run `nx graph` to show the graph of the workspace.
-It will show tasks that you can run with Nx.
+- A writer asks Vapi for help with character development, and Vapi responds with a creative prompt from the function designed for this purpose.
+- A writer requests a random name for a character, and Vapi uses the function for random name generation to provide a name with the specified gender and nationality.
 
-- [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph)
+## Conclusion
 
-## Connect with us!
+This sample project illustrates the power of Vapi customization for specific use cases, such as assisting story writers in their creative process. By following the examples and guidelines provided, developers can create a more versatile and responsive voice assistant that caters to the unique needs of their users.
 
-- [Join the community](https://nx.dev/community)
-- [Subscribe to the Nx Youtube Channel](https://www.youtube.com/@nxdevtools)
-- [Follow us on Twitter](https://twitter.com/nxdevtools)
+For additional help and documentation, refer to the official [Vapi documentation](https://docs.vapi.ai).