Merge pull request #23 from Microarchitecturovisco/update-readme

update readme

README.md

@@ -1,4 +1,54 @@
-# Travel UI
+# Travel agency frontend
+
+This is a frontend for travel agency application based on microservices architecture
+which can be found [here](https://github.com/Microarchitecturovisco/travel-api). 
+The app is written in TypeScript.
+
+
+## Table of contents
+- [Description](#description)
+- [Setup](#setup)
+- [Available Scripts](#available-scripts)
+## Description
+
+### Home Page
+This is the home page, where you can search for trips depending on your choise (destinations, numer of people, dates and departure places). 
+<div align="center">
+  <img src="photos/main_view.png" width="800"/>
+</div>
+
+### Clients Preferences
+You can easly switch to view with preferences of clients, where you can see which destinations, rooms, hotels, and transport types are most popular. You can also check information about last reservation to find an inspiration. This view is update in real time with usage of websockets.
+<div align="center">
+  <img src="photos/clients_preferences_view.png" width="800"/>
+</div>
+
+### Available Offers
+After you hit the search button, you will see Hotels which satisfie choosen parameters. From this view you also check hotel price and hotel rate.
+<div align="center">
+  <img src="photos/search_query_view.png" width="800"/>
+</div>
+
+### Offer details
+
+From previous view you can choose a Hotel to see its details. Here you see all the details of the hotel such as: description, photos, available rooms configurations with descriptions and catering options. You can change room configuration, catering option, departure place and number of guests. Each change will result in automatic price change. Additionally, if someone buys an offer with hotel you are viewing, you will see a popup in top right corner with this information. It is made with websocket usage. You can see the popup on photo below. 
+
+<div align="center">
+  <img src="photos/offer_details_view.png" width="800"/>
+</div>
+<div align="center">
+  <img src="photos/offer_photos_view.png" width="800"/>
+</div>
+<div align="center">
+  <img src="photos/offer_configuration_view.png" width="800"/>
+</div>
+
+### Reservation
+When you decide to purchase an offer you will see view with details of the trip. Here you can reserve an offer for 1 minute, during which you can decide to pay for an offer or decline it.
+
+<div align="center">
+  <img src="photos/reservation_view.png" width="800"/>
+</div>
 
 ## Setup
 
@@ -58,33 +108,3 @@ If you aren't satisfied with the build tool and configuration choices, you can `
 Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
 
 You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
-
-## Learn More
-
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
-
-### Code Splitting
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
-
-### Analyzing the Bundle Size
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
-
-### Making a Progressive Web App
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
-
-### Advanced Configuration
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
-
-### Deployment
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
-
-### `npm run build` fails to minify
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)