From 60e1f0f70d47a6644e70d259f39078865f19ca2f Mon Sep 17 00:00:00 2001 From: Dane Isburgh Date: Sat, 14 Oct 2023 15:23:05 -0400 Subject: [PATCH] docs: update README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f7d8a92..4608f07 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Practical Tuples -This project is a "to-do list" type application built on serverless real-time architecture. Users can create and share lists as well as manage access without requiring traditional account info (i.e. username and password). The app's frontend is built with [Angular](https://angular.io/) and the backend is built with [NestJS](https://nestjs.com/), and uses a [PostgreSQL](https://www.postgresql.org/) relational database. The app can be hosted in AWS with the frontend in [S3](https://aws.amazon.com/s3/) and the backend in [Lambda](https://aws.amazon.com/lambda/), managed by the [Serverless](https://www.serverless.com/) framework. Real-time communication between the frontend and backend is performed by persistent websocket connection that is maintained by [API Gateway](https://aws.amazon.com/api-gateway/). +This project is a real-time and cross-platform "to-do list" application built on serverless architecture. Users can create and share lists as well as manage access without requiring traditional account info (i.e. username and password). The frontend is built with the [Ionic Framework](https://ionicframework.com/) and can be compiled as a web, Android, and/or iOS application. The backend is built with [NestJS](https://nestjs.com/), and uses an [AWS Aurora Serverless](https://aws.amazon.com/rds/aurora/serverless/) relational database. The app can be hosted in AWS and managed by the [Serverless Framework](https://www.serverless.com/). Real-time communication between the frontend and backend is performed by persistent websocket connection that is maintained by [API Gateway](https://aws.amazon.com/api-gateway/). [![Integration](https://github.com/daneisburgh/practical-tuples/actions/workflows/integration.yml/badge.svg)](https://github.com/daneisburgh/practical-tuples/actions/workflows/integration.yml) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)