From 4a8a34fac74ff4134e8c613d4d05dca2167c01fb Mon Sep 17 00:00:00 2001 From: Eric Cabrel TIOGO Date: Fri, 16 Sep 2022 23:58:55 +0200 Subject: [PATCH] docs(app): update readme --- README.md | 3 +++ apps/functions/code-embed/README.md | 3 +++ packages/embed/README.md | 3 +-- 3 files changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0792dc96..d25be9b7 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,7 @@ Sharingan is an open-source code-sharing platform that makes it easy to create c * [MySQL 8 through PlanetScale](https://planetscale.com/) * [Prisma](https://www.prisma.io/) * [Tailwind CSS](https://tailwindcss.com/) +* [AWS](https://aws.amazon.com) ## Project Structure ```text @@ -27,11 +28,13 @@ sharingan ├─ apps │ ├─ core │ ├─ functions +│ │ ├─ code-embed │ ├─ web ├─ packages │ ├─ database │ ├─ embed │ ├─ domain +│ ├─ front │ ├─ logger │ ├─ utils package.json diff --git a/apps/functions/code-embed/README.md b/apps/functions/code-embed/README.md index 006259b5..e1fd219e 100644 --- a/apps/functions/code-embed/README.md +++ b/apps/functions/code-embed/README.md @@ -22,6 +22,9 @@ Here are the packages used in this project: * [@sharingan/embed](../../../packages/embed) ## Set up +> **Note**: This repo requires a connection to the database, follow the instructions in the **database** packages before going to the next step. + + Delete the existing folders output from build commands ```shell yarn clean diff --git a/packages/embed/README.md b/packages/embed/README.md index e3458305..28d81296 100644 --- a/packages/embed/README.md +++ b/packages/embed/README.md @@ -12,8 +12,7 @@ Make sure you have this tools installed before running the project * Node.js 16+ * NPM or Yarn -> **Note**: This repo requires a connection to the database, follow the instructions in the database packages before going to the next step. - +> **Note**: This repo requires a connection to the database, follow the instructions in the **database** packages before going to the next step. ## Set up the project Delete the existing folders output from build commands