Merge pull request #15 from sirji-ai/demos

Added YouTube videos for the demos
sirji-ai · Mar 29, 2024 · 6fc72a3 · 6fc72a3
2 parents df64212 + 3dfeb78
commit 6fc72a3
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 7 deletions.
diff --git a/demos/1-generate-readme/README.md b/demos/1-generate-readme/README.md
@@ -7,6 +7,7 @@ Clone the "sirji" repository: [email protected]:sirji-ai/sirji.git and checkout the
 ```
 
 ## Demo Video
-https://github.com/TrueSparrowSystems/sirji-demos/assets/7627517/aa84bcf5-80cf-49f5-b82b-ed58772404c2
 
+Watch on YouTube: https://www.youtube.com/watch?v=B9kWchC6lKw
 
+[![Sirji generates README](https://github.com/sirji-ai/sirji/assets/7627517/9fa49bee-8488-403d-a8b2-54c5aff05628)](https://www.youtube.com/watch?v=B9kWchC6lKw)
diff --git a/demos/2-routes-and-models-from-specs/README.md b/demos/2-routes-and-models-from-specs/README.md
@@ -9,5 +9,6 @@ Create API routes in modular files by understanding the OpenAPI specs file conte
 
 ## Demo Video
 
-https://github.com/TrueSparrowSystems/sirji-demos/assets/7627517/3f255148-7ea8-461f-8b80-f53c02a6e909
+Watch on YouTube: https://www.youtube.com/watch?v=Bl73DOqXrtg
 
+[![Sirji generating specs based models, migrations and routes](https://github.com/sirji-ai/sirji/assets/7627517/ceac9f4f-ec4b-48ec-bd75-7de8fbafa376)](https://www.youtube.com/watch?v=Bl73DOqXrtg)
diff --git a/demos/3-stock-price-website/README.md b/demos/3-stock-price-website/README.md
@@ -7,4 +7,6 @@ Generate a simple website to show the last closing, opening and current price of
 ```
 ## Demo Video
 
-https://github.com/TrueSparrowSystems/sirji-demos/assets/7627517/b69598d7-2579-4539-843c-046422882084
+Watch on YouTube: https://www.youtube.com/watch?v=fmYhbTGSTlA
+
+[![Sirji generating stock price website](https://github.com/sirji-ai/sirji/assets/7627517/a7abda56-fc99-406d-8b94-553ec8946799)](https://www.youtube.com/watch?v=fmYhbTGSTlA)
diff --git a/demos/README.md b/demos/README.md
@@ -1,12 +1,47 @@
 # Sirji Demos
 
-This repository features demo videos illustrating [Sirji](https://github.com/sirji-ai/sirji)'s approach to various problems.
+Following are some demo videos illustrating [Sirji](https://github.com/sirji-ai/sirji)'s approach to various problems.
 
 ## Demo 1: Generate README
-Explore [this link](./1-generate-readme) to see how Sirji interprets folder file contents to generate README, then pushes it to git.
+
+### Problem Statement
+
+```
+Clone the "sirji" repository: [email protected]:sirji-ai/sirji.git and checkout the "readme-demo" branch. Read and understand the content of all the files in the folder: "sirji/tools/crawler". Afterward, create a README.md file in that folder giving sample usages, a brief description of the steps performed, etc.
+```
+
+### Demo Video
+
+Watch on YouTube: https://www.youtube.com/watch?v=B9kWchC6lKw
+
+[![Sirji generates README](https://github.com/sirji-ai/sirji/assets/7627517/9fa49bee-8488-403d-a8b2-54c5aff05628)](https://www.youtube.com/watch?v=B9kWchC6lKw)
+
 
 ## Demo 2: Generate Models, Migrations, and Routes
-Explore [this link](./2-routes-and-models-from-specs) for a demo of Sirji downloading and understanding OpenAPI specs and DBML to generate model, migration, and route files for an express app.
+
+### Problem Statement
+```
+Create an Express App. Use PostgreSQL as the database and Sequelize as ORM.
+Create migration files and model files by understanding the DBML file content: https://github.com/sirji-ai/sirji/blob/main/demos/2-routes-and-models-from-specs/DBML.txt
+Create API routes in modular files by understanding the OpenAPI specs file content: https://github.com/sirji-ai/sirji/blob/main/demos/2-routes-and-models-from-specs/OpenAPI.yml
+```
+
+### Demo Video
+
+Watch on YouTube: https://www.youtube.com/watch?v=Bl73DOqXrtg
+
+[![Sirji generating specs based models, migrations and routes](https://github.com/sirji-ai/sirji/assets/7627517/ceac9f4f-ec4b-48ec-bd75-7de8fbafa376)](https://www.youtube.com/watch?v=Bl73DOqXrtg)
+
 
 ## Demo 3: Stock Price Website
-Explore [this link](./3-stock-price-website) for a demo of Sirji creating a simple website to display user-entered stock prices.
+
+### Problem Statement
+
+```
+Generate a simple website to show the last closing, opening and current price of user entered stock.
+```
+### Demo Video
+
+Watch on YouTube: https://www.youtube.com/watch?v=fmYhbTGSTlA
+
+[![Sirji generating stock price website](https://github.com/sirji-ai/sirji/assets/7627517/a7abda56-fc99-406d-8b94-553ec8946799)](https://www.youtube.com/watch?v=fmYhbTGSTlA)