updated readme

Author: DattatreyaReddy

README.md

@@ -1,3 +1,165 @@
-# yliw
+<p align="center">
+ <img width=200px height=200px src="assets/images/yliw.png" alt="YLIW logo"/>
+</p>
 
-A new Flutter project.
+<h3 align="center"> Your Life In Weeks </h3>
+
+
+<div align="center">
+
+[![Platform](https://img.shields.io/badge/platform-Android%20%7C%20iOS%20%7C%20Linux%20%7C%20Windows%20%7C%20MacOS%20%7C%20Web-lightgrey)][release]
+</div>
+
+<div align="center">
+
+[![GitHub Stars](https://img.shields.io/github/stars/DattatreyaReddy/yliw)](https://github.com/DattatreyaReddy/yliw)
+[![GitHub License](https://img.shields.io/github/license/DattatreyaReddy/yliw)](https://github.com/DattatreyaReddy/yliw/blob/main/LICENSE)
+![CI](https://github.com/DattatreyaReddy/yliw/actions/workflows/publish.yml/badge.svg)
+[![stable release](https://img.shields.io/github/release/DattatreyaReddy/yliw.svg?maxAge=3600&label=download)](https://github.com/DattatreyaReddy/yliw/releases)
+
+</div>
+
+
+
+<p align="center">
+A free and open source life tracking app.</br></br>
+Based on the <a href="http://waitbutwhy.com/2014/05/life-weeks.html">Your Life in Weeks</a> post by Tim Urban, from <a href="http://waitbutwhy.com/">Wait But Why</a>.
+</br></br>
+YLIW supports Linux, Windows, MacOS, Web, iOS and Android.
+</p>
+
+---
+
+## Downloading and Running the app
+
+### Android
+
+Download *-android-all.apk file from latest release [the releases section][release].
+
+
+### iOS
+
+- Download the latest .ipa file from [the releases section][release]
+- use [AltStore](https://altstore.io/) to install YLIW in ios.
+
+### Windows
+
+Download the latest .msi file from [the releases section][release].
+
+<!-- if you use WINGET, you can run
+```
+winget install yliw
+``` -->
+
+### MacOS
+
+- Download the *-macos-x64.zip from the latest release [the releases section][release]
+- Extract the file.
+- Drag and drop the extracted app file to applications folder in finder.
+
+<!-- if you use HomeBrew, you can run
+```
+brew install --cask yliw
+``` -->
+
+### Debian based Linux
+
+Download the latest deb release from [the releases section][release].
+
+<!-- ### Arch based Linux
+
+Download the latest release from [the aur](https://aur.archlinux.org/packages/yliw-bin).
+
+If you use yay, you can run
+```
+yay -S yliw-bin
+```
+inside a terminal window. -->
+
+### Web
+
+Download the latest web.zip file from [the releases section][release].
+
+- YLIW-web deployed in GitHub pages. You can check out [YLIW here](https://dattatreyareddy.github.io/yliw/).
+
+
+## Building from source
+
+These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
+
+### Prerequisites
+
+You can install Flutter & Dart from [Official website](https://docs.flutter.dev/get-started/install)
+
+  - Dart sdk
+  - Flutter - Channel Stable
+
+### Building
+
+1.  Clone the repository:
+
+```
+  $ git clone https://github.com/DattatreyaReddy/yliw.git
+  $ cd yliw/
+```
+2.  You can install all dependencies by running this command in terminal:
+
+```
+  $ flutter pub get
+```
+
+3.  Now enter the following command to start debugging the app:
+
+```
+  $ flutter run
+```
+
+-  Localization generator
+```
+  $ flutter gen-l10n
+```
+
+- Pull-Request Suggestion
+  - Install GitHooks after cloning the repo using `git config --local core.hooksPath .githooks`
+
+## Support and help
+
+-   Raise issue in github
+
+## Built Using
+
+- [Flutter](https://flutter.dev/) is an open source framework by Google for building beautiful, natively compiled, multi-platform applications from a single codebase.
+
+- [Flutter Riverpod](https://pub.dev/packages/riverpod/) - A simple way to access state while robust and testable.
+
+Find other dependencies in [pubspec.yaml](pubspec.yaml)
+
+## Credit
+
+- The `YLIW` project is developed by [@DattatreyaReddy](https://github.com/DattatreyaReddy) and contributors.
+
+- Based on the <a href="http://waitbutwhy.com/2014/05/life-weeks.html">Your Life in Weeks</a> post by Tim Urban, from <a href="http://waitbutwhy.com/">Wait But Why</a>.
+
+<!-- ## Translation
+Feel free to translate the project on [Weblate](https://hosted.weblate.org/projects/DattatreyaReddy/yliw/)
+
+<details><summary>Translation Progress</summary>
+<a href="https://hosted.weblate.org/engage/padya/">
+<img src="https://hosted.weblate.org/widgets/padya/-/yliw/multi-auto.svg" alt="Translation status" />
+</a>
+</details> -->
+
+## License
+
+You can obtain a copy of `Mozilla Public License v2.0` from https://mozilla.org/MPL/2.0/
+
+
+    Copyright (c) 2024 Panta Dattatreya Reddy
+
+    This Source Code Form is subject to the terms of the Mozilla Public
+    License, v. 2.0. If a copy of the MPL was not distributed with this
+    file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+
+[release]: https://github.com/DattatreyaReddy/yliw/releases
+[yliw]: https://github.com/DattatreyaReddy/yliw