diff --git a/{{cookiecutter.project_slug}}/README.md b/{{cookiecutter.project_slug}}/README.md index 9d28e0e..9a78d6e 100644 --- a/{{cookiecutter.project_slug}}/README.md +++ b/{{cookiecutter.project_slug}}/README.md @@ -9,12 +9,12 @@ For instructions on adding your API as a Custom Cognitive Skill in Azure Search https://docs.microsoft.com/en-us/azure/search/cognitive-search-custom-skill-interface ## Resources -This project uses FastAPI built on top of Starlette. - -FastAPI documenation: - -https://fastapi.tiangolo.com +This project has two key dependencies: +| Dependency Name | Documentation | Description | +|-----------------|------------------------------|----------------------------------------------------------------------------------------| +| spaCy | https://spacy.io | Industrial-strength Natural Language Processing (NLP) with Python and Cython | +| FastAPI | https://fastapi.tiangolo.com | FastAPI framework, high performance, easy to learn, fast to code, ready for production | --- ## Run Locally @@ -24,9 +24,13 @@ To run locally in debug mode run: cd ./{{cookiecutter.project_slug}} uvicorn app.api:app --reload ``` -Open your browser to http://localhost:8000/docs to view the SwaggerUI. +Open your browser to http://localhost:8000/docs to view the OpenAPI UI. For an alternate view of the docs navigate to http://localhost:8000/redoc --- +## Deploy with Azure Pipelines +Follow this guide to setup an Azure Resource Group with instances of Azure Kubernetes Service and Azure Container Registry and setup CI / CD with Azure Pipelines. + +https://docs.microsoft.com/en-us/azure/devops/pipelines/ecosystems/kubernetes/aks-template?view=azure-devops \ No newline at end of file