create a README for the project

MIT.md

@@ -0,0 +1,10 @@
+## Copyright 2021, [YOUR NAME]
+
+###### Please delete this line and the next one
+###### APP TYPE can be a webpage/website, a web app, a software and so on
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this [APP TYPE] and associated documentation files, to deal in the [APP TYPE] without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the [APP TYPE], and to permit persons to whom the [APP TYPE] is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the [APP TYPE].
+
+THE [APP TYPE] IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE [APP TYPE] OR THE USE OR OTHER DEALINGS IN THE [APP TYPE].

README.md

@@ -1,24 +1,161 @@
-# README
 
-This README would normally document whatever steps are necessary to get the
-application up and running.
 
-Things you may want to cover:
+<a name="readme-top"></a>
 
-* Ruby version
+<div align="center">
+  <br/>
 
-* System dependencies
+  <h2><b>Budget Tracker App</b></h2>
+<br>
+</div>
 
-* Configuration
+# 📗 Table of Contents
 
-* Database creation
+- [📗 Table of Contents](#-table-of-contents)
+- [📖 Budget App](#-budget-app)
+  - [🛠 Built With ](#-built-with-)
+    - [Tech Stack ](#tech-stack-)
+    - [Key Features ](#key-features-)
+  - [Live Demo](#live-demo)
+  - [💻 Getting Started ](#-getting-started-)
+    - [Prerequisites](#prerequisites)
+    - [Setup](#setup)
+    - [Install](#install)
+    - [Usage](#usage)
+    - [Test](#test)
+  - [Authors ](#authors-)
+  - [🔭 Future Features ](#-future-features-)
+  - [🤝 Contributing ](#-contributing-)
+  - [⭐️ Show your support ](#️-show-your-support-)
+  - [🙏 Acknowledgments ](#-acknowledgments-)
+  - [📝 License ](#-license-)
 
-* Database initialization
 
-* How to run the test suite
+# 📖 Budget App<a name="about-project"></a>
 
-* Services (job queues, cache servers, search engines, etc.)
+The Budget App is a web app developed with mobile-first approach that used for efficient budget management. This app allows users to track their expenses by maintaining a list of transactions associated with a category. By utilizing the app, users can easily visualize the amount of money they have spent and on what.
 
-* Deployment instructions
+## 🛠 Built With <a name="built-with"></a>
 
-* ...
+### Tech Stack <a name="tech-stack"></a>
+
+<details>
+  <summary>Ruby on Rails</summary>
+  <ul>
+    <li><a href="https://ruby-doc.org/3.2.2/">Ruby</a></li>
+  </ul>
+    <ul>
+    <li><a href="https://guides.rubyonrails.org/">Rails</a></li>
+  </ul>
+</details>
+
+### Key Features <a name="key-features"></a>
+
+- Record all expenses by creating a category
+- List all transactions associated with a category
+- All users to visualize how much money they spent on a category
+
+## Live Demo
+
+- [Live Demo](https://budget-tracker-pzur.onrender.com/)
+- [Project video Link](#)
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+## 💻 Getting Started <a name="getting-started"></a>
+
+To get a local copy up and running follow these simple example steps.
+
+### Prerequisites
+
+In order to run this project you need:
+
+- Code Editor (Vs Code) or any editor of your choice
+
+- Terminal
+
+- Install Ruby on your computer
+
+- Install Rails on your computer
+
+### Setup
+
+Clone this repository by using the command line to your desired folder:  
+
+```sh
+git clone  https://github.com/Microverse-Fullstack-Program/rails-budget-app
+
+cd rails-budget-app
+```
+
+### Install
+
+Install this project with:
+
+```sh
+cd rails-budget-app
+ bundle install (install all dependencies)
+```
+
+### Usage
+
+To run the project, execute the following command:
+
+```sh
+rails server
+```
+
+### Test
+
+```sh
+  rspec
+```
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+## Authors <a name="authors"></a>
+
+👤 **Chere Lemma**
+
+- GitHub: [Chere Lemma](https://github.com/cherelemma)
+- LinkedIn: [Chere (Urgaya) Lemma](https://www.linkedin.com/in/chere-lemma27211613/)
+- Twitter: [@Chere21271613](https://twitter.com/Chere21271613)
+
+
+## 🔭 Future Features <a name="future-features"></a>
+
+- [] Implement some UX improvements: like transitions and/or animations, etc.
+- [] Create a decent desktop design for the webapp.
+- [] Implement the left side menu to improve the navigability of the app.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+## 🤝 Contributing <a name="contributing"></a>
+
+Contributions, issues, and feature requests are welcome!
+
+Feel free to check the [issues page](https://github.com/Microverse-Fullstack-Program/rails-budget-app/issues)
+
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+## ⭐️ Show your support <a name="support"></a>
+
+Leave a star if you like the project.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+## 🙏 Acknowledgments <a name="acknowledgements"></a>
+
+design credits go to:
+[@Gregoire Vella](https://www.behance.net/gallery/19759151/Snapscan-iOs-design-and-branding?tracking_source=) - author of design
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+## 📝 License <a name="license"></a>
+
+This project is [MIT](./LICENSE) licensed.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>