Update the README file

README.md

@@ -1,24 +1,77 @@
-# README
+# Social media app with Ruby on Rails
 
-This README would normally document whatever steps are necessary to get the
-application up and running.
+> I base this Project on the Twitter web app. This project is a capstone project for Ruby on Rails framework. I learned a lot while I was doing the app; It was challenging at the beginning, but I overcome all the difficulties and I created a full stack application.
 
-Things you may want to cover:
+## Diagram for the App
 
-* Ruby version
+![screenshot](./docs/Diagram_social_media_image.png)
 
-* System dependencies
+## Demo Screenshots
 
-* Configuration
+![screenshot](./docs/screenshot.png)
+![screenshot](./docs/screenshot2.png)
+![screenshot](./docs/screenshot3.png)
+![screenshot](./docs/screenshot4.png)
 
-* Database creation
+## Live Demo
 
-* Database initialization
+[Live version](https://glacial-cove-94894.herokuapp.com/)
 
-* How to run the test suite
+## Prerequisites
 
-* Services (job queues, cache servers, search engines, etc.)
+Ruby: 2.7.0
+Rails: ~> 6.0.3
+Postgres: >=9.5
 
-* Deployment instructions
+## Getting Started
 
-* ...
+To get a local copy up and running follow these simple example steps.
+
+## 📝 Setup
+
+1. Open the terminal.
+2. On the terminal navigate to the project directory using `cd MCA-social/`.
+3. Install dependencies using: `bundle install`.
+3. If it required: `bundle update`.
+4. Migrate the database: `rails db:migrate`.
+5. If required run: `yarn install`, and repeate the step 4.
+6. Run rails `db:create`
+7. rails `db:migrate`
+8. Start the application : `rails server`.
+9. Open `http://localhost:3000/` in your browser.
+10. To Stop the application : Create a user.
+
+## Run tests
+
+- Open the terminal
+- Run `rpsec --format documentation`
+
+## Authors
+
+👤 **Kender Bolivar**
+
+- GitHub: [@kenderb](https://github.com/ken)
+- Twitter: [@twitterhandle](https://twitter.com/KBTarts )
+- LinkedIn: [KenderBolivar](https://www.linkedin.com/in/kender-bolivar-1736086b/ )
+
+
+## 🤝 Contributing
+
+Contributions, issues and feature requests are welcome!
+
+Feel free to check the [issues page](issues/).
+
+## Show your support
+
+Give a ⭐️ if you like this project!
+
+## :grey_exclamation: Acknowledgments
+
+- [Rails Guides](https://guides.rubyonrails.org/)
+- [Shoulda Matchers](https://matchers.shoulda.io/docs/v4.4.1/index.html)
+- Stack Overflow
+- Odin Project.
+
+## 📝 License
+
+[LICENSE](LICENSE)