From b7b90f4c658394bd490ce3a4c670c1e729734e31 Mon Sep 17 00:00:00 2001 From: Samuel Vange <7166607+svange@users.noreply.github.com> Date: Thu, 9 Nov 2023 19:45:36 -0800 Subject: [PATCH] docs: added info about the SAM template --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a28986c..8d55afa 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # OpenBrain -![ci status](https://github.com/svange/openbrain/actions/workflows/publish-release.yml/badge.svg?branch=main) +![ci status](https://github.com/svange/openbrain/actions/workflows/pipeline.yml/badge.svg?branch=main) ![PyPI - Version](https://img.shields.io/pypi/v/openbrain) [![License: AGPL v3](https://img.shields.io/badge/License-AGPL_v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) Code style: black @@ -58,6 +58,7 @@ To test Openbrain as a service, do the following: 2. Log in to the portal and subscribe to the Openbrain service. 3. Navigate to your dashboard in the portal and use your API keys to interact with the API. 4. A swagger UI and SDKs are available for subscribers. +5. (Optional) deploy the infrastructure to your AWS account using the SAM template provided in this repository (`resources.yaml`). NOTE: There is currently no fee for using the service, but it's using my personal AWS and OpenAI accounts, so I'll pull the plug immediately if it becomes expensive.