docs(app): update readme

tericcabrel · Sep 17, 2022 · 4a8a34f · 4a8a34f
1 parent 5db8f12
commit 4a8a34f
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -20,18 +20,21 @@ 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
 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
@@ -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
@@ -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