update readme

Fer14 · Aug 17, 2024 · cbebe66 · cbebe66
1 parent 1912adb
commit cbebe66
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -1,8 +1,24 @@
-## TODO:
-
-- poner los logos en los creditos
-- tutorial al empezar
-https://pub.dev/packages/in_app_review
-https://pub.dev/packages/table_calendar
-https://pub.dev/packages/shared_preferences
-https://pub.dev/packages/soundpool
+# dreamXplainer 🐑☁️
+
+![Logo](./logo.png)
+
+## What is dreamXplainer?
+
+**dreamXplainer** is a mobile application that helps you understand your _dreams_. It uses a machine learning model to analyze your dreams and provide you with an  <ins>explanation</ins> of what they might mean.
+
+
+## Android App
+
+This the open source code for the dreamXplainer Android App, previously on Play Store. Written in Flutter and using the openai api. Also integrates with adsense ads engine.
+
+<p float="center">
+  <img src="./screenshots/1.png" width="150" />
+  <img src="./screenshots/2.png" width="150" /> 
+  <img src="./screenshots/3.png" width="150" />
+  <img src="./screenshots/4.png" width="150" />
+</p>
+
+## Open source
+
+We decided to open source the project since we were not going to continue it. We deleted all api keys and tokens but you can put yours and it should work.
+
diff --git a/2.png → logo.png b/2.png → logo.png
diff --git a/screenshots/1.png b/screenshots/1.png
diff --git a/screenshots/2.png b/screenshots/2.png
diff --git a/screenshots/3.png b/screenshots/3.png
diff --git a/screenshots/4.png b/screenshots/4.png